PresenceV2

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:

• Available (green)
• Busy (red)
• Absent (yellow)
• Inactive (green/yellow)
• Don't disturb (red with a white stripe)
• Offline (gray)

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:

• Telephone (via CTI)
• Calendar
• Audio/Video
• Softphone
• Bluetooth device (locally attached to a client of the user).
• Manual input of the user

Prerequisite for using the interface

• The client needs a socket for secure data Transmission between client-server and vise versa.
• Installation of ProCall Software in advance
• Then create a user for testing purposes
• login in this user name and check the functionality of this interface practically

Functionalities

• The status for client will be driven from various sources like:
• Digital Telephone, Mobile, Calender(ms outlook), Audio/Video Chat, Manually changing Status and Computer system(login/logout).
• The user has the permission to manually change the status
• The user can set a user-defined status (ex: Coffee Break)
• The user can set a couple of notices (ex: listing the daily appointments)
• The user can change status and notice
• The user can remove status and notice

Events

The Events that the client receives from the server are:

- asnUpdatePresence :

• It delivers the responses from Server to Client as per Client request
• The Server receives the specific request like asnCustomNote from Client
• The Client reciprocally receives an asnUpdatePresence from Server
• The Update-Event will also be sent to those clients who are in touch with this client in the same Server
• It receives the Event from server in two forms whether an Argument or an Error
• As Argument: It handles the Presence and iChangedFlags events
  - Presence : it shows updated data of the present-contact.
  - iChangedFlags : it indicates that which area triggers the event and it's included because later on the server fills the fields
  * check the AsnPresence(Active details) for more details

- asnRemovePresence :

• It needs a contact id to remove the presence state
• It has an optionalParams for further implementation

Types:

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 This structure has been superseeded by the AsnClientCapabilitiesV2 structure
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.