Difference between revisions of "UBIK PUSH"
(Created page with "= UBIK PUSH = Ubik provides the possibility (since Version 4.8.1) to configure a default Push Mechanism. It can be configured and enabled for every UBIK object. If this object...") |
|||
| Line 15: | Line 15: | ||
PushScene PUSH_SCENE { get; } | PushScene PUSH_SCENE { get; } | ||
} | } | ||
| + | |||
| + | |||
| + | == Push Scene == | ||
| + | The Push Scene object defines what type of Push is sent. | ||
| + | UBIK will provide different push scenes to support different type of Pushes: | ||
| + | |||
| + | === Native Push Scene === | ||
| + | The native Push Scene is used to configure a native Push. If an object carrying the [[SYSCLS_PUSH_ITEM]] Classification refers to a Native Push Scene Object a native Push will be sent. | ||
| + | The Native Push Scene provides default credentials to use a UBIK Push Channel. | ||
| + | There is the possibility to configure different credentials by overwritting a custom - method: | ||
| + | |||
| + | protected virtual bool TryGetCustomCredentialParameter(CredentialParameter param, out string value) | ||
| + | { | ||
| + | } | ||
| + | |||
| + | |||
| + | === Native Push Topic === | ||
| + | You need to configure Push Topics. For one changed object we send one push for one topic. | ||
| + | The Push Topic must refer to the configured Native Push Scene. | ||
| + | To activate a Push Topic you need to define its TOPIC (string property) and ACTIVATE (boolean property) it. | ||
| + | |||
| + | Push Topics must be classified with [[SYSCLS_PUSH_TOPIC]] Classification. | ||
| + | If a UBIK client should receive a push message, the corresponding Push Topic must be available in ints infrastructure. | ||
| + | |||
| + | |||
| + | === Native Push Message === | ||
| + | The Textts for Push Messge are assembled based on the content of the saved object. | ||
| + | There is the possibility to overwrite these texts by using 2 string properties: | ||
| + | * PUSH_TITLE | ||
| + | * PUSH_MESSAGE | ||
Latest revision as of 12:57, 18 October 2024
Contents
UBIK PUSH
Ubik provides the possibility (since Version 4.8.1) to configure a default Push Mechanism. It can be configured and enabled for every UBIK object. If this object gets saved, a push is sent for this object automatically.
Push Item
To enable auto - push for an object you need to classify it with the SYSCLS PUSH ITEM Classification. This classification is for the server implementation only. No additional property must be configured to be sent to the client. The classification requires two things to be configured: PUSH_SCENE: you need to add the PUSH_SCENE (link) Property to the item You need to provide a method PushEnabled(). This method defines if push for the given object is enabled (true) or not.
public interface IPushObject : IBaseClass
{
bool PushEnabled();
PushScene PUSH_SCENE { get; }
}
Push Scene
The Push Scene object defines what type of Push is sent. UBIK will provide different push scenes to support different type of Pushes:
Native Push Scene
The native Push Scene is used to configure a native Push. If an object carrying the SYSCLS PUSH ITEM Classification refers to a Native Push Scene Object a native Push will be sent. The Native Push Scene provides default credentials to use a UBIK Push Channel. There is the possibility to configure different credentials by overwritting a custom - method:
protected virtual bool TryGetCustomCredentialParameter(CredentialParameter param, out string value)
{
}
Native Push Topic
You need to configure Push Topics. For one changed object we send one push for one topic. The Push Topic must refer to the configured Native Push Scene. To activate a Push Topic you need to define its TOPIC (string property) and ACTIVATE (boolean property) it.
Push Topics must be classified with SYSCLS PUSH TOPIC Classification. If a UBIK client should receive a push message, the corresponding Push Topic must be available in ints infrastructure.
Native Push Message
The Textts for Push Messge are assembled based on the content of the saved object. There is the possibility to overwrite these texts by using 2 string properties:
- PUSH_TITLE
- PUSH_MESSAGE
