Changes
Created page with "This activity pushes a single Popup Message to {{UBIK}} Push service participants. <!-- DO NOT REMOVE THIS -->{{Template:Activity/Begin}}<!-- DO NOT REMOVE THIS --> = Descri..."
This activity pushes a single Popup Message to {{UBIK}} Push service participants.
<!-- DO NOT REMOVE THIS -->{{Template:Activity/Begin}}<!-- DO NOT REMOVE THIS -->
= Description =
{{ActivityInfoBox
| title = PushPopUpMessage
| name = PushPopUpMessage
| image =
| imagecaption = Activity PushPopUpMessage
| purpose = Push a Popup Message
| category = UBIK Push
| returns = true if successful
| version = 2.4.3+
}}
===Arguments===
{| class="wikitable sortable" | width = "50%"
|-
! Argument !! Type !! Direction !! Purpose
|- align="left"
| Header|| [[string]] || In || The header line of the PopUp Message
|- align="left"
| TextLines|| [[Array of Strings]] || In || The text (as single lines) from the Popup Message
|- align="left"
| Style|| [[StyleTypes]] || In || The layout style of the presented message at the client (Notification, ImportantInformation, Failure, Emergency)
|- align="left"
| UBIKObject || [[BaseClass]] || In || The object the push Message refers to; this argument is mutually exclusive with the argument ''UBIKObjectUID''
|- align="left"
| UBIKObjectUID || {{Guid}} || In || The UID of the object the push Message refers to; this argument is mutually exclusive with the argument ''UBIKObject''
|- align="left"
| PushClient || [[Push Service (Client)|PushService]] || In || The instantiated push client to be used; normally inherited from a hosting [[Activity:CreatePushScope (Activity)|CreatePushScope]] activity, but can be overwritten here
|}
===Usage===
Use this activity to push a single Popup Message to certain {{UBIK}} Clients. The criterions to which clients the object should be actually pushed can be defined with subsequent PushCriterion activities.
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 criterions like PushCriterionLogin, either as direct children but also wrapped within looping activities like ForEach or While.
=== Style Types ===
The system supports following styles:
* Notification
* Important Information
* Failure
* Emergency
=Example=
This example pushes a Message with a refered object (with the defined UID) to all clients of its hosting [[Activity:CreatePushScope (Activity)|CreatePushScope]] activity as defined in its subsequent criterions; if no criterions are defined the push will be received by all clients of the push service.
{| class="wikitable" | width = "50%"
|-
! Argument!! Value
|- align="left"
| UBIKObjectUID|| new System.Guid("f5eea25c-9ad4-4be4-b11a-5814a4160c3e")
|- align="left"
| Header|| "Headerline"
|- align="left"
| Textlines|| new String() {"Line 1", "Line 2", "Line 3"}
|- align="left"
| Style|| StyleTypes.Emergency
|}
<!-- DO NOT REMOVE THIS -->{{Template:Activity/End}}<!-- DO NOT REMOVE THIS -->
==See also==
* [[Workflow Designer]]
* [[Activity:CreatePushScope (Activity)]]
[[Category:Activities]]
[[Category:Push]]
<!-- DO NOT REMOVE THIS -->{{Template:Activity/Begin}}<!-- DO NOT REMOVE THIS -->
= Description =
{{ActivityInfoBox
| title = PushPopUpMessage
| name = PushPopUpMessage
| image =
| imagecaption = Activity PushPopUpMessage
| purpose = Push a Popup Message
| category = UBIK Push
| returns = true if successful
| version = 2.4.3+
}}
===Arguments===
{| class="wikitable sortable" | width = "50%"
|-
! Argument !! Type !! Direction !! Purpose
|- align="left"
| Header|| [[string]] || In || The header line of the PopUp Message
|- align="left"
| TextLines|| [[Array of Strings]] || In || The text (as single lines) from the Popup Message
|- align="left"
| Style|| [[StyleTypes]] || In || The layout style of the presented message at the client (Notification, ImportantInformation, Failure, Emergency)
|- align="left"
| UBIKObject || [[BaseClass]] || In || The object the push Message refers to; this argument is mutually exclusive with the argument ''UBIKObjectUID''
|- align="left"
| UBIKObjectUID || {{Guid}} || In || The UID of the object the push Message refers to; this argument is mutually exclusive with the argument ''UBIKObject''
|- align="left"
| PushClient || [[Push Service (Client)|PushService]] || In || The instantiated push client to be used; normally inherited from a hosting [[Activity:CreatePushScope (Activity)|CreatePushScope]] activity, but can be overwritten here
|}
===Usage===
Use this activity to push a single Popup Message to certain {{UBIK}} Clients. The criterions to which clients the object should be actually pushed can be defined with subsequent PushCriterion activities.
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 criterions like PushCriterionLogin, either as direct children but also wrapped within looping activities like ForEach or While.
=== Style Types ===
The system supports following styles:
* Notification
* Important Information
* Failure
* Emergency
=Example=
This example pushes a Message with a refered object (with the defined UID) to all clients of its hosting [[Activity:CreatePushScope (Activity)|CreatePushScope]] activity as defined in its subsequent criterions; if no criterions are defined the push will be received by all clients of the push service.
{| class="wikitable" | width = "50%"
|-
! Argument!! Value
|- align="left"
| UBIKObjectUID|| new System.Guid("f5eea25c-9ad4-4be4-b11a-5814a4160c3e")
|- align="left"
| Header|| "Headerline"
|- align="left"
| Textlines|| new String() {"Line 1", "Line 2", "Line 3"}
|- align="left"
| Style|| StyleTypes.Emergency
|}
<!-- DO NOT REMOVE THIS -->{{Template:Activity/End}}<!-- DO NOT REMOVE THIS -->
==See also==
* [[Workflow Designer]]
* [[Activity:CreatePushScope (Activity)]]
[[Category:Activities]]
[[Category:Push]]
