Presence interface (Version 2)
This module defines structures and operations for the presence V2 interface.
A version 2 of the presence interface was necessary to improve the amount of contact and service data.
The presence shows at any time the current availability of the person you wish to communicate with. For a detailed description see the help of the UCClient.
The following presence states are available:
Additionally the API delivers information in form of contact data, service states and much more.
With all these infromations, it is possible to create an application, which give user the ability to see a detailed picture of a contact enriched with live state changes.
The live changes are results of the different services the UCServer combines the presence state of the user:
Prerequisite for using the interface
The Events that the client receives from the server are:
How the API works
Here is a very simple diagram of how the presence API works
Operation to retrieve contact data and to subscribe to events when these data will change.
Operation to end subscriptions on contacts on the ucserver.
Operation to set access rights for another contact on contact data and contcat service information.
This operation is used for removing access rights to contact data and service states between contacts.
Request an large image of a contact.
Request an image of a contact
Event from the server to the client about presence updates
Event from the server tzhat the contact has been removed from the presence system.
This enum is for selecting the events and direct return values in which the client is interested when it calls asnGetAndSubscribePresence
This enumeration describes possible values returning from the server calling asnRemoveDynamicRights
The structure is used to describe a phone line of a contact.
This structure describes the information about a call on a phone line.
This strutures describes the phone forward state of a phone line.
- DEPRECATED - Structure of client capabilities.
Structure for AsnPresence to give the client a hint, whcih access rights are effective to set on an contact.
Struture for AsnPresence of the actual agent state of the contact
Argument for the event asnRemovePresence
Call this operation to get information about and events of another contact.
Argument for stopping contact subscrptions on the ucserver.
Result of asnUnsubscribePresence if the operation was executed successfully
Argument for asnSetDynamicRights to set/change access rights to contact data and its service informations
Result of asnSetDynamicRights if the operation was successful.
Argument for asnRemoveDynamicRights
Result of asnRemoveDynamicRights
Argument for asnRequestLargeProfileImage
Result of asnRequestLargeProfileImage
Argument for asnRequestContactImage
Result of asnRequestContactImage
List of AsnPresenceLine structures.
List of AsnPresenceCall structures.
List of AsnPresenceForward structures.
This sequence contains the data and service states of a contact, called its 'presence'.
List of AsnPresence sequences
Argument of asnUpdatePresence
Result of asnGetAndSubscribePresence with the list of successfully subscribed contacts.