Class IterableAction

IterableAction represents an action defined as a response to user events.

It is currently used in push notification actions (open push & action buttons).

Index

Constructors

Properties

data? type userInput?

Methods

Constructors

constructor

new IterableAction(
    type: string,
    data?: string,
    userInput?: string,
): IterableAction
Creates an instance of IterableAction.
Parameters
- type: string
  The type of the action.
- Optionaldata: string
  Optional data associated with the action.
- OptionaluserInput: string
  Optional user input related to the action.
Returns IterableAction
- Defined in core/classes/IterableAction.ts:25

Properties

`Optional`data

data?: string

Determines the action. EG: "open_url", "open_in_app", "deep_link", "join" etc.

type

type: string

The type of iterable action.

`Optional`userInput

userInput?: string

Additional info related to the action.

Methods

`Static`fromDict

fromDict(dict: IterableAction): IterableAction
Creates an instance of IterableAction from a dictionary object.
Parameters
- dict: IterableAction
  The dictionary object containing the properties to initialize the IterableAction instance.
Returns IterableAction
A new instance of IterableAction initialized with the provided dictionary properties.
- Defined in core/classes/IterableAction.ts:37