Collapse all Symbian^3 Application Developer Library

MSimpleWatcher Class Reference

class MSimpleWatcher

SIMPLE Engine presence watcher

simpleengine

Since: S60 3.2

Public Member Functions
void	Close ()
const MSimpleConnection &	Connection ()
TInt	GetPresenceL (const TDesC8 &, MSimpleFilterDocument *, TBool )
TUint	SIPRetryAfter ()
TUint	SIPStatus ()
TSimpleSipSubscriptionState	SipSubscriptionState ()
TInt	SubscribeL (const TDesC8 &, MSimpleFilterDocument *, TBool , TBool )
TInt	SubscribeListL (const TDesC8 &, MSimpleFilterDocument *, TBool , TBool )
TInt	UnsubscribeL ()

Public Member Enumerations
enum	TSimpleSipSubscriptionState { ESimpleStateNone = 0, ESimpleStatePending , ESimpleStateActive , ESimpleStateTerminated }

Member Functions Documentation

Close()

void

(

)

[pure virtual]

Destroy this entity

Since: S60 3.2

Connection()

const MSimpleConnection &

Connection

(

)

[pure virtual]

Getter for the SIMPLE Engine connection.

Since: S60 3.2

GetPresenceL(const TDesC8 &, MSimpleFilterDocument *, TBool)

TInt	GetPresenceL	(	const TDesC8 &	aURI,
			MSimpleFilterDocument *	aFilter,
			TBool	aAnonymous
		)	[pure virtual]

Get presence data Leaves with KErrInUse if there is already active subscription in this MSimpleWatcher entity.

Since: S60 3.2

Parameters

const TDesC8 & aURI	URI of entity to be subscribed
MSimpleFilterDocument * aFilter	filter data, may be NULL.
TBool aAnonymous	whether anonymous subscription is wanted

SIPRetryAfter()

TUint

SIPRetryAfter

(

)

[pure virtual]

SIP Retry-after header value accessor. Get the SIP retry-fater header value of the last completed request. Refer to RFC3261, RFC3265, RFC3903.

Since: S60 3.2

SIPStatus()

TUint

SIPStatus

(

)

[pure virtual]

SIP Status code accessor. Get the status of the last completed request. Refer to RFC3261, RFC3265, RFC3903.

Since: S60 3.2

SipSubscriptionState()

TSimpleSipSubscriptionState

SipSubscriptionState

(

)

[pure virtual]

SIP Subscription-state header value accessor. Get the SIP Subscription-state header value of the last NOTIFY message or ESimpleStateTerminated when the subscription is terminated by a client. Refer to RFC3265

Since: S60 3.2

SubscribeL(const TDesC8 &, MSimpleFilterDocument *, TBool, TBool)

TInt	SubscribeL	(	const TDesC8 &	aURI,
			MSimpleFilterDocument *	aFilter,
			TBool	aRefresh,
			TBool	aAnonymous
		)	[pure virtual]

Subscribe presence entity. Expiry time is set based on SIMPLE settings. Leaves with KErrInUse if there is already active subscription in this MSimpleWatcher entity.

Since: S60 3.2

Parameters

const TDesC8 & aURI	URI of entity to be subscribed
MSimpleFilterDocument * aFilter	filter data, may be NULL.
TBool aRefresh	whether refresh is made automatically
TBool aAnonymous	whether anonymous subscription is wanted

SubscribeListL(const TDesC8 &, MSimpleFilterDocument *, TBool, TBool)

TInt	SubscribeListL	(	const TDesC8 &	aURI,
			MSimpleFilterDocument *	aFilter,
			TBool	aRefresh,
			TBool	aAnonymous
		)	[pure virtual]

Subscribe presence list. Expiry time is set based on SIMPLE settings. Leaves with KErrInUse if there is already active subscription in this MSimpleWatcher entity.

Since: S60 3.2

Parameters

const TDesC8 & aURI	URI of entity to be subscribed
MSimpleFilterDocument * aFilter	filter data, may be NULL.
TBool aRefresh	whether refresh is made automatically
TBool aAnonymous	whether anonymous subscription is wanted

UnsubscribeL()

TInt

UnsubscribeL

(

)

[pure virtual]

Unsubscribe. Leaves with KErrNotFound if there is no active subscription.

Since: S60 3.2

Member Enumerations Documentation

Enum TSimpleSipSubscriptionState

SIP subscription-state

Enumerators

ESimpleStateNone = 0
ESimpleStatePending
ESimpleStateActive
ESimpleStateTerminated