ILinkAction
in
Tags
Table of Contents
Methods
- getAppId() : string
- Returns the app ID of the action
- getDisplayId() : string
- Returns the translated unique display ID of the action
- getIcon() : string
- Returns the URL link to the 16*16 SVG icon
- getId() : string
- Returns the unique ID of the action
- getPriority() : int
- Returns the priority
- getTarget() : string|null
- Returns the target of the action, if null is returned the action won't be registered
- getTitle() : string
- Returns the translated title
- preload() : void
- Preload the user specific value required by the action
Methods
getAppId()
Returns the app ID of the action
public
getAppId() : string
e.g. 'spreed'
Tags
Return values
stringgetDisplayId()
Returns the translated unique display ID of the action
public
getDisplayId() : string
Should be something short and descriptive of the action as this is seen by the end-user when configuring actions
e.g. 'Email'
Tags
Return values
stringgetIcon()
Returns the URL link to the 16*16 SVG icon
public
getIcon() : string
Tags
Return values
stringgetId()
Returns the unique ID of the action
public
getId() : string
For account properties this is the constant defined in lib/public/Accounts/IAccountManager.php
e.g. 'email'
Tags
Return values
stringgetPriority()
Returns the priority
public
getPriority() : int
Actions are sorted in ascending order
e.g. 60
Tags
Return values
intgetTarget()
Returns the target of the action, if null is returned the action won't be registered
public
getTarget() : string|null
e.g. 'mailto:user@domain.com'
Tags
Return values
string|nullgetTitle()
Returns the translated title
public
getTitle() : string
e.g. 'Mail user@domain.com'
Use the L10N service to translate it
Tags
Return values
stringpreload()
Preload the user specific value required by the action
public
preload(IUser $targetUser) : void
e.g. the email is loaded for the email action and the userId for the Talk action
Parameters
- $targetUser : IUser