Collapse all Symbian^3 Product Developer Library

CCbsMessageClient Class Reference

class CCbsMessageClient : public CBase

CBS Message API e.g for Cover UI's needs. This API is a smaller snapshot of CBS Client API.

CbsClient.lib

Since: 3.2

Inherits from

CCbsMessageClient
- CBase

Public Member Functions
IMPORT_C TInt	FindMessageByHandle(const TCbsMessageHandle &, TCbsMessage &)
IMPORT_C TInt	FindTopicByNumber(const TCbsTopicNumber, TCbsTopic &)
IMPORT_C TInt	GetMessage(const TCbsTopicNumber, const TInt, TCbsMessage &)
IMPORT_C TInt	GetMessageContents(const TCbsMessageHandle &, TDes &)
IMPORT_C TInt	GetMessageCount(const TCbsTopicNumber, TInt &)
IMPORT_C TInt	GetTopic(const TInt, TCbsTopic &)
IMPORT_C CCbsMessageClient *	NewL()
IMPORT_C TInt	SetMessageAsRead(const TCbsMessageHandle &)
IMPORT_C TInt	TopicCount()
IMPORT_C TInt	UnreadMessageCount()

Protected Member Functions
	CCbsMessageClient()

Inherited Functions
	CBase::CBase()
	CBase::Delete(CBase *)
	CBase::Extension_(TUint,TAny &,TAny )
	CBase::operator new(TUint)
	CBase::operator new(TUint,TAny *)
	CBase::operator new(TUint,TLeave)
	CBase::operator new(TUint,TLeave,TUint)
	CBase::operator new(TUint,TUint)
	CBase::~CBase()

Constructor & Destructor Documentation

CCbsMessageClient()

CCbsMessageClient

(

)

[protected]

Default constructor.

Member Functions Documentation

FindMessageByHandle(const TCbsMessageHandle &, TCbsMessage &)

IMPORT_C TInt	FindMessageByHandle	(	const TCbsMessageHandle &	aHandle,
			TCbsMessage &	aMessage
		)	[pure virtual]

Finds a message by given handle.

Parameters

const TCbsMessageHandle & aHandle	Handle to the message.
TCbsMessage & aMessage	Return: contains the message information.

FindTopicByNumber(const TCbsTopicNumber, TCbsTopic &)

IMPORT_C TInt	FindTopicByNumber	(	const TCbsTopicNumber	aNumber,
			TCbsTopic &	aTopic
		)	[pure virtual]

Finds the topic by the given number.

Return values:

Parameters

const TCbsTopicNumber aNumber	Number of the topic
TCbsTopic & aTopic	Return: contains the topic information

GetMessage(const TCbsTopicNumber, const TInt, TCbsMessage &)

IMPORT_C TInt	GetMessage	(	const TCbsTopicNumber	aNumber,
			const TInt	aIndex,
			TCbsMessage &	aMessage
		)	[pure virtual]

Returns message information.

Parameters

const TCbsTopicNumber aNumber	Number of the topic
const TInt aIndex	Index to the message in topic.
TCbsMessage & aMessage	Returns: the message information

GetMessageContents(const TCbsMessageHandle &, TDes &)

IMPORT_C TInt	GetMessageContents	(	const TCbsMessageHandle &	aHandle,
			TDes &	aBuffer
		)	[pure virtual]

Returns the message contents.

Parameters

const TCbsMessageHandle & aHandle	Handle to the message.
TDes & aBuffer	It will contain the contents (as much as it fits).

GetMessageCount(const TCbsTopicNumber, TInt &)

IMPORT_C TInt	GetMessageCount	(	const TCbsTopicNumber	aNumber,
			TInt &	aCount
		)	[pure virtual]

Returns the total amount of messages the topic contains.

Return codes:

Parameters

const TCbsTopicNumber aNumber	Number of the topic.
TInt & aCount	Number of messages in given topic.

GetTopic(const TInt, TCbsTopic &)

IMPORT_C TInt	GetTopic	(	const TInt	aIndex,
			TCbsTopic &	aTopic
		)	[pure virtual]

Returns information about a topic from the topic list.

Parameters

const TInt aIndex	Index to the topic.
TCbsTopic & aTopic	It will contain the topic information.

NewL()

IMPORT_C CCbsMessageClient *

NewL

(

)

[static]

Instantiates new CCbsMessageClient object. During instantaion connection to CBS Server is created.

SetMessageAsRead(const TCbsMessageHandle &)

IMPORT_C TInt

SetMessageAsRead

(

const TCbsMessageHandle &

aHandle

)

[pure virtual]

Sets the message as read.

Parameters

const TCbsMessageHandle & aHandle

Handle to the message to be set read.

TopicCount()

IMPORT_C TInt

TopicCount

(

)

[pure virtual]

Returns the total amount of topics the topic list contains.

UnreadMessageCount()

IMPORT_C TInt

UnreadMessageCount

(

)

[pure virtual]

Returns the total amount of unread messages.