Changes
Created page with "The CreatePushScope Activity is the root activity for pushing objects using the [[Push Service (Client)|{{UBIK}} Push Service]]. <!-- DO NOT REMOVE THIS -->{{Template:Activit..."
The CreatePushScope Activity is the root activity for pushing objects using the [[Push Service (Client)|{{UBIK}} Push Service]].
<!-- DO NOT REMOVE THIS -->{{Template:Activity/Begin}}<!-- DO NOT REMOVE THIS -->
= Description =
{{ActivityInfoBox
| title = CreatePushScope
| name = CreatePushScope
| image =
| imagecaption = Activity CreatePushScope
| purpose = Initiates a push session
| category = UBIK Push
| returns = true if successful
| version = 2.4.2+
}}
===Arguments===
{| class="wikitable sortable" | width = "50%"
|-
! Argument !! Type !! Direction !! Purpose
|- align="left"
| PushURL || {{string}} || In || The URL to a configured [[Push Service (Client)|{{UBIK}} Push Service]]
|- align="left"
| PushClient || [[Push Service (Client)|PushService]] || Out || A reference to the instantiated Push Service object; this will be automatically passed to all sub push activities
|- align="left"
| 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=
{| class="wikitable" | width = "50%"
|-
! Argument!! Value
|- align="left"
| argument || example of value
|- align="left"
| argument || example of value
|}
<!-- DO NOT REMOVE THIS -->{{Template:Activity/End}}<!-- DO NOT REMOVE THIS -->
==See also==
* [[Workflow Designer]]
[[Category:Activities]]
<!-- DO NOT REMOVE THIS -->{{Template:Activity/Begin}}<!-- DO NOT REMOVE THIS -->
= Description =
{{ActivityInfoBox
| title = CreatePushScope
| name = CreatePushScope
| image =
| imagecaption = Activity CreatePushScope
| purpose = Initiates a push session
| category = UBIK Push
| returns = true if successful
| version = 2.4.2+
}}
===Arguments===
{| class="wikitable sortable" | width = "50%"
|-
! Argument !! Type !! Direction !! Purpose
|- align="left"
| PushURL || {{string}} || In || The URL to a configured [[Push Service (Client)|{{UBIK}} Push Service]]
|- align="left"
| PushClient || [[Push Service (Client)|PushService]] || Out || A reference to the instantiated Push Service object; this will be automatically passed to all sub push activities
|- align="left"
| 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=
{| class="wikitable" | width = "50%"
|-
! Argument!! Value
|- align="left"
| argument || example of value
|- align="left"
| argument || example of value
|}
<!-- DO NOT REMOVE THIS -->{{Template:Activity/End}}<!-- DO NOT REMOVE THIS -->
==See also==
* [[Workflow Designer]]
[[Category:Activities]]
