PushSender
Realm Operations
Resource path:
/realm-config/authentication/authenticationtrees/nodes/PushAuthenticationSenderNode
Resource version: 2.0
create
Usage
am> create PushSender --realm Realm --id id --body body
Parameters
- --id
-
The unique identifier for the resource.
- --body
-
The resource in JSON format, described by the following JSON schema:
{ "type" : "object", "properties" : { "messageTimeout" : { "title" : "Message Timeout", "description" : "The duration (in ms) that the message will time out after.", "propertyOrder" : 100, "type" : "integer", "exampleValue" : "" }, "captureFailure" : { "title" : "Capture failure", "description" : "If selected, failure to send the Push Notification is captured in shared state for use by subsequent nodes in the journey.", "propertyOrder" : 700, "type" : "boolean", "exampleValue" : "" }, "pushType" : { "title" : "Push Type", "description" : "This field allows selection of the Push notification type. The 'Tap to Accept' is the default notification type, it just requires the user to Accept it. The 'Display Challenge Code' requires the user to enter the matching code on the user's device before processing the notification. The 'Use Biometrics to Accept' requires local Biometric authentication to process the notification.", "propertyOrder" : 600, "type" : "string", "exampleValue" : "" }, "userMessage" : { "title" : "User Message", "description" : "The message to send to the user. {{user}} and {{issuer}} may be used as replacements for the username and issuer name respectively.", "propertyOrder" : 200, "patternProperties" : { ".*" : { "type" : "string" } }, "type" : "object", "exampleValue" : "" }, "contextInfo" : { "title" : "Share Context Info", "description" : "If checked, additional context information will be added into the notification. The data contains remoteIp, userAgent, and location. Note that the location attribute requires the presence of Device Profile Collector node in the Tree with 'Collect Device Location' config enabled.", "propertyOrder" : 400, "type" : "boolean", "exampleValue" : "" }, "mandatory" : { "title" : "Remove 'skip' option", "description" : "If checked, users will no longer be able to skip the module, and must interact with it.", "propertyOrder" : 300, "type" : "boolean", "exampleValue" : "" }, "customPayload" : { "title" : "Custom Payload Attributes", "description" : "Shared state objects which will be included in the message payload sent to the client. Maximum payload for both iOS and Android is 3KB.", "propertyOrder" : 500, "items" : { "type" : "string" }, "type" : "array", "exampleValue" : "" } }, "required" : [ "messageTimeout", "captureFailure", "pushType", "userMessage", "contextInfo", "mandatory", "customPayload" ] }
delete
Usage
am> delete PushSender --realm Realm --id id
Parameters
- --id
-
The unique identifier for the resource.
getAllTypes
Obtain the collection of all secondary configuration types related to the resource.
Usage
am> action PushSender --realm Realm --actionName getAllTypes
getCreatableTypes
Obtain the collection of secondary configuration types that have yet to be added to the resource.
Usage
am> action PushSender --realm Realm --actionName getCreatableTypes
listOutcomes
List the available outcomes for the node type.
Usage
am> action PushSender --realm Realm --body body --actionName listOutcomes
Parameters
- --body
-
The resource in JSON format, described by the following JSON schema:
{ "type" : "object", "title" : "Some configuration of the node. This does not need to be complete against the configuration schema." }
nextdescendents
Obtain the collection of secondary configuration instances that have been added to the resource.
Usage
am> action PushSender --realm Realm --actionName nextdescendents
query
Get the full list of instances of this collection. This query only supports _queryFilter=true filter.
Usage
am> query PushSender --realm Realm --filter filter
Parameters
- --filter
-
A CREST formatted query filter, where "true" will query all.
read
Usage
am> read PushSender --realm Realm --id id
Parameters
- --id
-
The unique identifier for the resource.
update
Usage
am> update PushSender --realm Realm --id id --body body
Parameters
- --id
-
The unique identifier for the resource.
- --body
-
The resource in JSON format, described by the following JSON schema:
{ "type" : "object", "properties" : { "messageTimeout" : { "title" : "Message Timeout", "description" : "The duration (in ms) that the message will time out after.", "propertyOrder" : 100, "type" : "integer", "exampleValue" : "" }, "captureFailure" : { "title" : "Capture failure", "description" : "If selected, failure to send the Push Notification is captured in shared state for use by subsequent nodes in the journey.", "propertyOrder" : 700, "type" : "boolean", "exampleValue" : "" }, "pushType" : { "title" : "Push Type", "description" : "This field allows selection of the Push notification type. The 'Tap to Accept' is the default notification type, it just requires the user to Accept it. The 'Display Challenge Code' requires the user to enter the matching code on the user's device before processing the notification. The 'Use Biometrics to Accept' requires local Biometric authentication to process the notification.", "propertyOrder" : 600, "type" : "string", "exampleValue" : "" }, "userMessage" : { "title" : "User Message", "description" : "The message to send to the user. {{user}} and {{issuer}} may be used as replacements for the username and issuer name respectively.", "propertyOrder" : 200, "patternProperties" : { ".*" : { "type" : "string" } }, "type" : "object", "exampleValue" : "" }, "contextInfo" : { "title" : "Share Context Info", "description" : "If checked, additional context information will be added into the notification. The data contains remoteIp, userAgent, and location. Note that the location attribute requires the presence of Device Profile Collector node in the Tree with 'Collect Device Location' config enabled.", "propertyOrder" : 400, "type" : "boolean", "exampleValue" : "" }, "mandatory" : { "title" : "Remove 'skip' option", "description" : "If checked, users will no longer be able to skip the module, and must interact with it.", "propertyOrder" : 300, "type" : "boolean", "exampleValue" : "" }, "customPayload" : { "title" : "Custom Payload Attributes", "description" : "Shared state objects which will be included in the message payload sent to the client. Maximum payload for both iOS and Android is 3KB.", "propertyOrder" : 500, "items" : { "type" : "string" }, "type" : "array", "exampleValue" : "" } }, "required" : [ "messageTimeout", "captureFailure", "pushType", "userMessage", "contextInfo", "mandatory", "customPayload" ] }