Presence interface (Version 2)
Module description
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
Functionalities
Events
The Events that the client receives from the server are:
Name | Description |
---|---|
AsnPresenceAction |
This Command is an Enumerated Command |
AsnPresenceSubscriptionFlags |
The Enum is for selecting the event sections in which the client is interested |
AsnSetDynamicRightsErrorEnum |
This command specifies the type of Error which is occurred after granting rights |
AsnRemoveDynamicRightsErrorEnum |
This Command specifies some determined Enum which represents the Error |
EnumRequestImageResult |
This Command represents the image result |
AsnPresenceLine |
The AsnPresenceLine shows if the line is busy or not |
AsnPresenceCall |
This Command displays the current call status of the Caller. |
AsnPresenceForward |
This Command displays the current call status of the Caller while forwarding the call. |
AsnContactCapabilities |
- DEPRECATED - It show the abilities which is offered to the client |
AsnActualUserDynamicRights |
This Command shows the current privilege of the client |
AsnRemovePresenceArgument |
Invoked (Event) signaling changes for a Contact |
AsnGetAndSubscribePresenceArgument |
Tell the UCServer which Events you want to have for the logged in Contact (ME) |
AsnUnsubscribePresenceArgument |
This is an argument for unsubscribing a contact from contact list |
AsnUnsubscribePresenceResult |
if the subscription is done perfectly then result will be shown |
AsnSetDynamicRightsArgument |
This Command tends to the privileges which are being granted to the other clients by this client |
AsnSetDynamicRightsResult |
This is the result that you get after you grant privileges to the other client |
AsnSetDynamicRightsError |
Generic error sequence. See the documentation of the operations specific descriptions. |
AsnRemoveDynamicRightsArgument |
This argument has only the OwnerContactID and the RemoteContactID |
AsnRemoveDynamicRightsResult |
This command shows the result of revoking privilege |
AsnRequestLargeProfileImageArgument |
This argument will be sent to Server to request for a large profile image |
AsnRequestLargeProfileImageResult |
This the large Profile Image result which is send from server |
AsnRequestContactImageArgument |
This Argument is for Requesting an image of a contact |
AsnRequestContactImageResult |
This Command shows the result for Requesting an image of a contact |
AsnMonitorGroupingAttribute | |
AsnSetMonitorGroupingAttributeResult |
Result of asnSetMonitorGroupingAttribute |
AsnPresenceLines | |
AsnPresenceCalls |
The AsnPresenceCalls has the same attribute as AsnPresenceCall |
AsnPresenceForwards |
This Command does the same thing as asnPresenceForward |
AsnPresence |
This Command is for providing status for client |
AsnPresenceList |
The ansPresenceList has the same attribute as asnPresence |
AsnUpdatePresenceArgument |
Invoked (Event) signaling changes for a Contact |
AsnGetAndSubscribePresenceResult |
This Command is the result of subscribed contact |
AsnSetMonitorGroupingAttributeArgument |
Argument for asnSetMonitorGroupingAttribute |
AsnAgentState | |
AsnRemoveDynamicRightsError |
Generic error sequence. See the documentation of the operations specific descriptions. |
Version 6.4