AddUpdateAction ( updateId, action, groupId )
Adds an update action for the specified Update and/or Group id. At least one of the id's must be provided.
| Name | Type | Description |
|---|
| updateId | System.String | The identifier of the update event. |
| action | System.Func{Componyx.UI.Bindary.Client,System.Object,System.Object,System.Threading.Tasks.Task} | The action to call when the update event fires. |
| groupId | System.String | The group to which the update belongs. |
ClearSubscriptions ()
Removes all client subscriptions.
GetSubscription ( updateId, client, groupId )
Returns the client subscription for the specified update event.
| Name | Type | Description |
|---|
| updateId | System.String | The identifier of the update event. |
| client | Componyx.UI.Bindary.Client | The client. |
| groupId | System.String | The group to which the update belongs. |
ReturnsThe subscription for the specified update event and client.
HasSubscription ( updateId, client, groupId )
Checks if the client is subscribed to the specified update event.
| Name | Type | Description |
|---|
| updateId | System.String | The identifier of the update event. |
| client | Componyx.UI.Bindary.Client | The client. |
| groupId | System.String | The group to which the update belongs. |
ReturnsA boolean value indicating if the client is subscribed to the specified update event.
Subscribe ( updateId, client, groupId, args )
Subscribes a client for an update event.
| Name | Type | Description |
|---|
| updateId | System.String | The identifier of the update event. |
| client | Componyx.UI.Bindary.Client | The client. |
| groupId | System.String | The group to which the update belongs. |
| args | System.Object | Arguments to bind to the subscription. |
Subscriptions ( updateId, groupId )
Returns the subscribed clients for the specified update event.
| Name | Type | Description |
|---|
| updateId | System.String | The identifier of the update event. |
| groupId | System.String | The group to which the update belongs. |
Unsubscribe ( client, groupId )
Removes all subscriptions of the specified client.
| Name | Type | Description |
|---|
| client | Componyx.UI.Bindary.Client | The client. |
| groupId | System.String | The group for which the client subscriptions must be removed. |
Unsubscribe ( updateId, client, groupId, startsWithSearch )
Removes the client subscription for the specified update event.
| Name | Type | Description |
|---|
| updateId | System.String | The identifier of the update event. |
| client | Componyx.UI.Bindary.Client | The client. |
| groupId | System.String | The group to which the update belongs. |
| startsWithSearch | System.Boolean | A value indicating if subscriptions of the specified client which start with the specified update identifier are removed. |
Unsubscribe ( updateId, groupId, startsWithSearch )
Removes all client subscriptions for the specified update event.
| Name | Type | Description |
|---|
| updateId | System.String | The identifier of the update event. |
| groupId | System.String | The group to which the update belongs. |
| startsWithSearch | System.Boolean | A value indicating if subscriptions which start with the specified update identifier are removed. |
Update ( client, groupId, args )
Calls all update event actions for the specified subscriber.
| Name | Type | Description |
|---|
| client | Componyx.UI.Bindary.Client | The client. |
| groupId | System.String | The group to which the update belongs. |
| args | System.Object | An object to pass as second argument to the action method. |
Update ( updateId, client, groupId, args )
Invokes the specified update event for the specified subscriber.
| Name | Type | Description |
|---|
| updateId | System.String | The identifier of the update event. |
| client | Componyx.UI.Bindary.Client | The client. |
| groupId | System.String | The group to which the update belongs. |
| args | System.Object | An object to pass as second argument to the action method. |
Update ( groupId, args )
Invokes all update event actions for all subscribers.
| Name | Type | Description |
|---|
| groupId | System.String | The group to which the update belongs. |
| args | System.Object | An object to pass as second argument to the action method. |
Update ( updateId, groupId, args )
Invokes the specified update event actions for all subscribers.
| Name | Type | Description |
|---|
| updateId | System.String | The identifier of the update event. |
| groupId | System.String | The group to which the update belongs. |
| args | System.Object | An object to pass as second argument to the action method. |