This activity pushes a single content object to UBIK® Push service participants.
Description
| PushContent | |
|---|---|
| Name | PushContent |
| Purpose | Push a single object |
| Category | UBIK Push |
| Returns | true if successful |
| Version | 2.4.2+ |
Arguments
| Argument | Type | Direction | Purpose |
|---|---|---|---|
| UBIKObject | BaseClass | In | The object to be pushed; this argument is mutually exclusive with the argument UBIKObjectUID |
| UBIKObjectUID | Guid | In | The UID of the object to be pushed; this argument is mutually exclusive with the argument UBIKObject |
| ParentDepth | Integer | In | The number of hierarchical parent levels to be also updated when a push is received |
| ChildrenDepth | Integer | In | The number of hierarchical child levels to be also updated when a push is received |
| PushClient | PushService | In | The instantiated push client to be used; normally inherited from a hosting CreatePushScope activity, but can be overwritten here |
Usage
Use this activity to push a single object 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.
Example
This example pushes the object with the defined UID to all clients of its hosting 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.
| Argument | Value |
|---|---|
| UBIKObjectUID | new System.Guid("f5eea25c-9ad4-4be4-b11a-5814a4160c3e") |