Documentation

Action

This contract represents a notification action.

Table of Contents

actionDetails()  : mixed
Returns information about this action, including name and description.
getText()  : string
Returns a action text summary when displaying to the user.
getTitle()  : string
Returns a action title for displaying in the action settings form.
triggerAction()  : void
Triggers this action.

Methods

actionDetails()

Returns information about this action, including name and description.

public actionDetails() : mixed
Return values
mixed

getText()

Returns a action text summary when displaying to the user.

public getText() : string
Return values
string

getTitle()

Returns a action title for displaying in the action settings form.

public getTitle() : string
Return values
string

triggerAction()

Triggers this action.

public triggerAction(array<string|int, mixed> $params) : void
Parameters
$params : array<string|int, mixed>
Return values
void

Search results