Skip to main content

FlowPushNotification Methods

An object defining methods for the FlowPushNotification class.

AddConstantPosition(id, code, description)

Adds a position to the push notification's recipient list using its ID, code, and description.

Parameters:

id (required): long
The unique identifier of the position.

code (required): string
The code of the position.

description (required): string
The description of the position.

Returns:

Type: void
Method does not return anything

This is a sync method. Method runs synchronously.


AddConstantPosition(id)

Adds a position to the push notification's recipient list using its ID.

Parameters:

id (required): long
The unique identifier of the position.

Returns:

Type: void
Method does not return anything

This is a sync method. Method runs synchronously.


AddConstantUser(id)

Adds a user to the push notification's recipient list using their ID.

Parameters:

id (required): long
The unique identifier of the user.

Returns:

Type: void
Method does not return anything

This is a sync method. Method runs synchronously.


Initialize()

Initializes the push notification step with default settings.

Returns:

Type: void
Method does not return anything

This is a sync method. Method runs synchronously.


ClearMembers()

Clears all members from the push notification's recipient configuration.

Returns:

Type: void
Method does not return anything

This is a sync method. Method runs synchronously.


SendPushNotification(userInfo, requestItem)

Sends a push notification to a specified user based on a process request item.

Parameters:

userInfo (required): UserInfo
The user information of the notification recipient.

requestItem (required): ProcessRequestItem
The process request item triggering the notification.

Returns:

Type: void
Method does not return anything

This is a sync method. Method runs synchronously.


AddConstantUser(id, code, name)

Adds a user to the push notification's recipient list using their ID, code, and name.

Parameters:

id (required): long
The unique identifier of the user.

code (required): string
The code of the user.

name (required): string
The name of the user.

Returns:

Type: void
Method does not return anything

This is a sync method. Method runs synchronously.