The CreatePushScope Activity is the root activity for pushing objects using the UBIK® Push Service.
[edit]
Description
| CreatePushScope | |
|---|---|
| Name | CreatePushScope |
| Purpose | Initiates a push session |
| Category | UBIK Push |
| Returns | true if successful |
| Version | 2.4.2+ |
Arguments
| Argument | Type | Direction | Purpose |
|---|---|---|---|
| PushURL | String | In | The URL to a configured UBIK® Push Service |
| Authentication | String | In | A valid Authentication Token the Push service must use. Use (e.g.) Authenticate - Activity to create a Token. If this parameter is empty, the system generates a temporary debug token. But be aware, that these kind of tokens are only supported as long as the USAM Service is in debug mode. |
| PushClient | PushService | Out | A reference to the instantiated Push Service object; this will be automatically passed to all sub push activities |
| Result | Boolean | Out | true if successful, false if an error occurred |
Usage
This activity initiates a push session and is therefore the starting point for pushing objects in UBIK®. It is a nestable activity, which means it can host any amount of sub-activities that will be processed sequentially. The hosted activities are typically Push activities like PushContent, either as direct children but also wrapped within looping activities like ForEach or While.
Example
This example settings will create a secure connection to the Push service of the UBIK® cloud demo:
| Argument | Value |
|---|---|
| PushURL | "https://137.135.200.180/UBIK/DEMO.240.PUSH/UBIKPush.svc" |