Collapse all Symbian^3 Product Developer Library

MSimplePublisher Class Reference

class MSimplePublisher

SIMPLE Engine presence data publisher

simpleengine

Since: S60 3.2

Public Member Functions
void	Close()
const MSimpleConnection &	Connection()
TInt	ContinuePublishL(MSimpleDocument &, TBool, const TDesC8 &)
TInt	ModifyPublishL(MSimpleDocument &)
TPtrC8	SIPETag()
TUint	SIPRetryAfter()
TUint	SIPStatus()
void	SetSIPETagObserver(MSimpleETagObserver *)
TInt	StartPublishL(MSimpleDocument &, TBool)
TInt	StopPublishL()
TInt	StopPublishL(const TDesC8 &)

Member Functions Documentation

Close()

void

(

)

[pure virtual]

Destroy this entity

Since: S60 v3.2

Connection()

const MSimpleConnection &

Connection

(

)

[pure virtual]

Getter for the SIMPLE Engine connection.

Since: S60 3.2

ContinuePublishL(MSimpleDocument &, TBool, const TDesC8 &)

TInt	ContinuePublishL	(	MSimpleDocument &	aDocument,
			TBool	aRefresh,
			const TDesC8 &	aETag
		)	[pure virtual]

Continue data publication Leaves with KErrInUse if there is already active publication in this MSimplePublisher entity. Expiry time is set based on SIMPLE settings. Refreshing is made by SIMPLE Engine.

Since: S60 3.2

Parameters

MSimpleDocument & aDocument	data to be published
TBool aRefresh	whether refresh is made automatically
const TDesC8 & aETag	SIP ETag header value to be used in SIP-If-Match header.

ModifyPublishL(MSimpleDocument &)

TInt

ModifyPublishL

(

MSimpleDocument &

aDocument

)

[pure virtual]

Update published data. This will overwrite the previous presence data. StartPublishL() must be completed before calling this method. Remote URI is not modified but taken from an initial StartPublishL document.

Since: S60 3.2

Parameters

MSimpleDocument & aDocument

data to be published

SIPETag()

TPtrC8

SIPETag

(

)

[pure virtual]

SIP ETag header value accessor. Refer to RFC3903.

Since: S60 3.2

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

SetSIPETagObserver(MSimpleETagObserver *)

void

SetSIPETagObserver

(

MSimpleETagObserver *

aObs

)

[pure virtual]

SIP ETag header value change observer setter. Notice that this value may change after each modification or automatic refresh of publication. Observer is called when the ETag value changes next time. Refer to RFC3903.

Since: S60 3.2

Parameters

MSimpleETagObserver * aObs

ETag value observer. Can be NULL to stop notification.

StartPublishL(MSimpleDocument &, TBool)

TInt	StartPublishL	(	MSimpleDocument &	aDocument,
			TBool	aRefresh
		)	[pure virtual]

Start to publish data. Leaves with KErrInUse if there is already active publication in this MSimplePublisher entity. Expiry time is set based on SIMPLE settings. Refreshing is made by SIMPLE Engine.

Since: S60 3.2

Parameters

MSimpleDocument & aDocument	data to be published
TBool aRefresh	whether refresh is made automatically

StopPublishL()

TInt

StopPublishL

(

)

[pure virtual]

Stop publishing data.

Since: S60 3.2

StopPublishL(const TDesC8 &)

TInt

StopPublishL

(

const TDesC8 &

aETag

)

[pure virtual]

Stop publication.

Since: S60 3.2

Parameters

const TDesC8 & aETag

SIP ETag header value to be used in SIP-If-Match header.