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 |
| 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
| Argument | Value |
|---|---|
| argument | example of value |
| argument | example of value |