cisco.uc.cuae.legacy
Interface PresenceClient

All Superinterfaces:

CuaeCommon, CuaeCommonClient, Presence

All Known Implementing Classes:

BasePresenceClient, RemotePresenceClient

public interface PresenceClient
extends Presence, CuaeCommonClient

The Presence API provides mechanisms to receive real-time status changes of presentities using the SIMPLE protocol. The API does not currently support updating the presence status of presentities from the application. Generated from CUAE provider package Metreos.Providers.Presence

Nested Class Summary

Nested classes/interfaces inherited from interface cisco.uc.cuae.legacy.Presence

Presence.NonTriggeringSubscribeOptions, Presence.NonTriggeringSubscribeResult, Presence.NotifyOptions, Presence.SubscriptionTerminatedOptions, Presence.TriggeringSubscribeOptions, Presence.TriggeringSubscribeResult, Presence.UnsubscribeOptions, Presence.UnsubscribeResult

Nested classes/interfaces inherited from interface cisco.uc.cuae.legacy.CuaeCommon

CuaeCommon.CuaeResult

Nested classes/interfaces inherited from interface cisco.uc.cuae.legacy.CuaeCommon

CuaeCommon.CuaeResult

Method Summary

void	notify(java.lang.String sessionId, Presence.NotifyOptions options) Notify indicates that the status has changed on the presentity, and what that change is.
void	subscriptionTerminated(java.lang.String sessionId, Presence.SubscriptionTerminatedOptions options) SubscriptionTerminated indicates that a subscription has been ended by the application or the presence server.

Method Detail

subscriptionTerminated

void subscriptionTerminated(java.lang.String sessionId,
                            Presence.SubscriptionTerminatedOptions options)

SubscriptionTerminated indicates that a subscription has been ended by the application or the presence server. The SubscriptionTerminated event indicates that a subscription is over, and no further Notify events will be received for that subscription. When an application successfully ends a subscription with an Unsubscribe, the SubscriptionTerminated event will occur after its successful completion.

Parameters:

sessionId - The session Id for this method call

options - An object holding all the optional parameters

notify

void notify(java.lang.String sessionId,
            Presence.NotifyOptions options)

Notify indicates that the status has changed on the presentity, and what that change is. Notify is fired every time a change occurs on the presentity. The Status event parameter contains the status update message, which can either stored in a string variable type and therefore be parsed by the application, or can be used to initialize the PresenceNotification native type, which has already parsed the message into well-known members.

Parameters:

sessionId - The session Id for this method call

options - An object holding all the optional parameters