2022 June Release

Actions of FSCPUSHNOTIFICATION@1.1001 Permanent link for this heading

Return Type

Signature

any

AttrGroupSendPushNotificationsCtor(
  AttributeDefinition attrdef,
  out retval any value)

void

AttrGroupSendPushNotificationsGet(
  AttributeDefinition attrdef,
  ref any value,
  out optional boolean volatile,
  out optional boolean volatiletx)

boolean

CanConfigurePushNotificationSettings(
  out retval boolean allowed)

boolean

CanUsePushNotifications(
  optional object obj,
  out retval boolean canuse)

boolean

CheckPushNotificationPolicy(
  out retval boolean allowsend)

string

EvaluatePredefinedService(
  PredefinedService predefinedservice,
  out retval string url)

PushNotificationService

GetPushNotificationService(
  out retval PushNotificationService pns)

void

PushNotificationPolicyChanged(
  AttributeDefinition attrdef)

void

RegisterPushNotificationDevice(
  string token,
  optional string deviceid,
  optional string devicename,
  optional WorkStationType devicetype)

void

SendPushNotification(
  string title,
  string[] body,
  optional object obj,
  optional string link)

void

UnregisterAllPushNotificationDevices()

void

UnregisterPushNotificationDevice(
  optional string deviceid)


FSCPUSHNOTIFICATION@1.1001:AttrGroupSendPushNotificationsCtor Permanent link for this heading

Attribute constructor action to define the initialization value.

any FSCPUSHNOTIFICATION@1.1001:AttrGroupSendPushNotificationsCtor(
  AttributeDefinition attrdef,
  out retval any value)

Name

Description

attrdef

value

Additional Information


FSCPUSHNOTIFICATION@1.1001:AttrGroupSendPushNotificationsGet Permanent link for this heading

Get action to retrieve the initialization value of the policy.

void FSCPUSHNOTIFICATION@1.1001:AttrGroupSendPushNotificationsGet(
  AttributeDefinition attrdef,
  ref any value,
  out optional boolean volatile,
  out optional boolean volatiletx)

Name

Description

attrdef

value

volatile

volatiletx

Additional Information


FSCPUSHNOTIFICATION@1.1001:CanConfigurePushNotificationSettings Permanent link for this heading

Action used to check whether push notification settings can be configured.

boolean FSCPUSHNOTIFICATION@1.1001:CanConfigurePushNotificationSettings(
  out retval boolean allowed)

Name

Description

allowed

When true, the configuration of push notification settings is allowed.

Additional Information


FSCPUSHNOTIFICATION@1.1001:CanUsePushNotifications Permanent link for this heading

Defines whether push notifications can be used.
May be overridden by other software components.

boolean FSCPUSHNOTIFICATION@1.1001:CanUsePushNotifications(
  optional object obj,
  out retval boolean canuse)

Name

Description

obj

An optional object, which can be used for additional checks.

canuse

When true, push notifications can be used.

Additional Information


FSCPUSHNOTIFICATION@1.1001:CheckPushNotificationPolicy Permanent link for this heading

Defines whether the group policy allows push notifications.

boolean FSCPUSHNOTIFICATION@1.1001:CheckPushNotificationPolicy(
  out retval boolean allowsend)

Name

Description

allowsend

Defines whether sending push notifications for the object is allowed by group policy.

Additional Information


FSCPUSHNOTIFICATION@1.1001:EvaluatePredefinedService Permanent link for this heading

Evaluates the predefined service and returns an appropriate push notification service URL.

string FSCPUSHNOTIFICATION@1.1001:EvaluatePredefinedService(
  PredefinedService predefinedservice,
  out retval string url)

Name

Description

predefinedservice

The predefined service which should be evaluated.

url

The push notification service URL which represents a Fabasoft Business Process Cloud data location.
If predefinedservice does not contain a valid value of PredefinedService the returned URL will be null.

Additional Information


FSCPUSHNOTIFICATION@1.1001:GetPushNotificationService Permanent link for this heading

Get the service from PushNotificationConfiguration.

PushNotificationService FSCPUSHNOTIFICATION@1.1001:GetPushNotificationService(
  out retval PushNotificationService pns)

Name

Description

pns

The push notification service.

Additional Information


FSCPUSHNOTIFICATION@1.1001:PushNotificationPolicyChanged Permanent link for this heading

Action called when the push notification policy is changed in the user interface.

void FSCPUSHNOTIFICATION@1.1001:PushNotificationPolicyChanged(
  AttributeDefinition attrdef)

Name

Description

attrdef

The policy attribute definition.

Additional Information


FSCPUSHNOTIFICATION@1.1001:RegisterPushNotificationDevice Permanent link for this heading

Registers a new or updates an existing push notification device for a user.
The device is uniquely identified by the deviceid.

void FSCPUSHNOTIFICATION@1.1001:RegisterPushNotificationDevice(
  string token,
  optional string deviceid,
  optional string devicename,
  optional WorkStationType devicetype)

Name

Description

token

The token which is used to deliver push notifications.

deviceid

An optional device id. If not set, the current workstation id (wsid) is used.

devicename

An optional device name. If not set, the current workstation name (objname) is used.

devicetype

An optional device type. If not set, the current workstation type (wstype) is used.

Additional Information


FSCPUSHNOTIFICATION@1.1001:SendPushNotification Permanent link for this heading

Sends a push notification to all registered devices of a user.
Either title or body must have a value, otherwise no notification will be sent.
CanUsePushNotifications will be evaluated, if false, no notification will be sent.

void FSCPUSHNOTIFICATION@1.1001:SendPushNotification(
  string title,
  string[] body,
  optional object obj,
  optional string link)

Name

Description

title

The title text for the notification.

body

The multiline body text for the notification. String list will be joined with "\n".

obj

The concerned object. Will also be checked by CanUsePushNotifications.

link

An optional MX link to an object, which will be opened when the notification is clicked/tapped.
HTTPS is required for web push notifications.

Additional Information


FSCPUSHNOTIFICATION@1.1001:UnregisterAllPushNotificationDevices Permanent link for this heading

Unregisters all push notification devices of a user.

void FSCPUSHNOTIFICATION@1.1001:UnregisterAllPushNotificationDevices()

Additional Information


FSCPUSHNOTIFICATION@1.1001:UnregisterPushNotificationDevice Permanent link for this heading

Unregisters a push notification device of a user.
The device is uniquely identified by the deviceid.

void FSCPUSHNOTIFICATION@1.1001:UnregisterPushNotificationDevice(
  optional string deviceid)

Name

Description

deviceid

An optional device id. If not set, the current workstation id (wsid) is used.

Additional Information