Constructor.

Destructor.

Adds a new topic. The handle assigned to the topic will be returned in aTopic.

Return values: KErrNone Topic was successfully added. KErrAlreadyExists A topic of the same number already exists in DB KErrArgument Topic number given was not in a proper range. KErrDiskFull Topic not added - FFS out of space

Note that the number of the new topic must be unused.

Changes topic hotmark status.

Changes the name and number of the existing topic.

Note that the changing fails in case there is another topic with the new topic number. It also fails if the topic is protected.

Return values: KErrNone Topic name and number successfully changed. KErrDiskFull Topic information not changed - FFS out of space

Changes topic subscription status.

Closes the session to the server.

Creates connection to the server.

Note that the method must be called before calling any other methods. The method returns an error code and, therefore, the caller is responsible of checking that everything went just fine.

Returns ETrue if CbsServer session has been established.

Delete all topics.

Deletes an existing message.

Note that it does not care a lot about the status of the message.

Please check also the description of LockMessage() .

Deletes an existing topic.

Finds a message by given handle.

Finds the topic by the given number.

Return values: KErrNone Topic returned in parameter aTopic. KErrNotFound Topic was not found.

Returns the handle to the latest hotmarked message that has been received after the system has started up.

Returns the preferred languages in aLanguages.

Returns the number of the topic which was last added to topic list.

Note: if a topic list cache is maintained by the client (as CBS UI application does), this function has to be called BEFORE calling GetTopicCount() and GetTopic() to make sure that no topic is added in between GetTopic() and GetLatestTopicHandle() calls. If this happens, GetLatestTopicHandle() will return a handle to a topic that is not cached client-side.

Return codes: KErrNone aNumber is a valid topic number. KErrNotFound No topic added since server start, aNumber is not valid.

Returns message information.

Return codes: KErrNotFound Topic or message not found. KErrNone aMessage contains the message information.

Returns the message contents.

Returns the total amount of messages the topic contains.

Return codes: KErrNotFound Invalid handle. KErrNone aCount contains the number of messages in topic

Returns the index of a message with given handle in topic.

Result code KErrNotFound indicates that no message was found with the given handle.

Returns the number of topics added since last GetNewTopicsCount() by the topic detection feature.

Returns the handles of messages that precede and succeed the given message in server-side list of topic messages.

Topic is resolved from the given message handle

If the given handle specifies the first message in topic, aPosition has ECbsHead bit up. If the given handle specifies the last message in topic, aPosition has ECbsTail bit up.

Return code values: KErrNone aPrevMsgHandle, aNextMsgHandle and aPosition contain valid values. KErrNotFound aCurrentMsgHandle specified a message that was not found.

Returns the numbers of topics that precede and succeed the given topic in server-side topic list.

If the given topic is the first topic in list, aPosition has ECbsHead bit up. If the given topic is the last topic in list, aPosition has ECbsTail bit up.

Return code values: KErrNone aPrevTopicNumber, aNextTopicNumber and aPosition contain valid values. KErrNotFound aCurrentTopicNumber specified a topic that was not on topic list.

Returns the reception status in aStatus, which is ETrue if the reception is on. Otherwise it is EFalse.

Returns information about a topic from the topic list.

Return values: KErrArgument Topic was not found.

Rest of return values indicate a file error.

Returns the total amount of topics the topic list contains.

Returns the topic detection status in aStatus, which is ETrue if the detection is on. Otherwise it is EFalse.

Returns the total amount of unread messages.

Returns ETrue, if there is a topic not accessed with NextTopic()

Checks if the server is already started.

Locks the message.

Note that a single topic messages subsession can have at most one locked message.

Message can be unlocked by trying to lock a null message. Locked message will also be automatically unlocked when subsession is closed. If a message is locked, then it will not be deleted from the database. Thus, deleting a message or trying to delete a topic that contains such a message will fail.

Locking a message does not prevent to save the message nor read the message.

Returns the next topic in the topic collection skipping all topics with a topic number matching a topic already listed in the current topic list. This function will return KErrNotFound if the collection is tried to access beyond the end of the list. Otherwise the error code will be the same returned by GetTopicInfo().

Requests the server to notify the client whenever an event occurs that changes the information of the topics.

Note that the client may select what kind of events it is interested in. Note also that there can be at most one pending request per instance of the class.

Cancels the pending notify request.

Requests the server to notify the client whenever any settings will be changed.

Note that for each subsession only one this kind of request can be pending. Each client is responsible of assuring this.

Cancels the request to notify the client.

Returns the number of unread messages in hotmarked topics.

This function is to used by the client when deciding whether the message or topic list view should be opened to display a hotmarked message(s).

Sets the message as read.

Saves a message (the saved message won't be deleted to make room for new messages).

Return codes: KErrNone Message is saved. KErrGeneral Message not saved -- total maximum of saved messages reached. KErrNotFound Message not saved -- no message associated with the given handle. KErrDiskFull Message not saved -- FFS out of space.

Changes the preferred languages to aLanguages.

Changes the reception status to aStatus.

Changes the topic detection status to aStatus.

Forces the server to shut down.

Resets the iterator. Must be called prior any call to HasNextTopic() or NextTopic()!

Starts the server.

Returns the version of CbsClient.

CbsServer and CbsClient must be of same version.