Jump to: navigation, search

Difference between revisions of "Authenticate (Activity)"

(Created page with "This activity pushes a single content object to {{UBIK}} Push service participants. <!-- DO NOT REMOVE THIS -->{{Template:Activity/Begin}}<!-- DO NOT REMOVE THIS --> = Descr...")
 
(→‎Arguments)
Line 20: Line 20:
 
! Argument !! Type !! Direction !! Purpose  
 
! Argument !! Type !! Direction !! Purpose  
 
|- align="left"
 
|- align="left"
−
| UBIKObject || [[BaseClass]] || In || The object to be pushed; this argument is mutually exclusive with the argument ''UBIKObjectUID''
+
| Application || [[String]] || In || The object to be pushed; this argument is mutually exclusive with the argument ''UBIKObjectUID''
 
|- align="left"
 
|- align="left"
−
| UBIKObjectUID || {{Guid}} || In || The UID of the object to be pushed; this argument is mutually exclusive with the argument ''UBIKObject''
+
| AuthenticationResult || {{AuthenticationResult}} || Out || The UID of the object to be pushed; this argument is mutually exclusive with the argument ''UBIKObject''
 
|- align="left"
 
|- align="left"
 
| ParentDepth || {{Integer}} || In || The number of hierarchical parent levels to be also updated when a push is received
 
| ParentDepth || {{Integer}} || In || The number of hierarchical parent levels to be also updated when a push is received
Line 30: Line 30:
 
| 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
 
| 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===
 
===Usage===

Revision as of 10:56, 25 March 2020

This activity pushes a single content object to UBIK® Push service participants.


[edit]

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
Application String In The object to be pushed; this argument is mutually exclusive with the argument UBIKObjectUID
AuthenticationResult AuthenticationResult Out 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")


See also

Retrieved from "https://wiki.augmensys.com/index.php?title=Authenticate_(Activity)&oldid=22154"