Delegate that can be used to retrieve status updates for a message. More...

#import <CSMessage.h>

Inherits <NSObjectNSObject>.

Instance Methods
(void)	- message:didChangeBody:
	Called to report that the message's body text has changed in response to a local setBodyAndReportTyping:completionHandler: (CSMessage) operation. More...

(void)	- message:didChangeInReplyTo:
	Called to report that the message's in-reply-to attribute has changed in response to a local setInReplyTo:completionHandler: (CSMessage) operation. More...

(void)	- message:didChangeLastModifiedDate:
	Called to report that the last modified date attribute of the message has changed. More...

(void)	- message:didChangeHasAttachmentStatus:
	Called to report that the list of attachments associated with the message has changed. More...

(void)	- message:didChangeHasUnreadAttachmentStatus:
	Called to report that the unread attachment status of the message has changed. More...

(void)	- message:didChangeDoNotForwardStatus:
	Called to report that the "do not forward" status of the message has changed. More...

(void)	- message:didChangeReadState:
	Called to report that the read state of the message has changed. More...

(void)	- message:didChangeDeliveryState:
	Called to report that the delivery state of the message has changed. More...

(void)	- message:didChangeStatus:
	Called to report that the status of the message has changed. More...

(void)	- message:didChangeImportance:
	Called to report that the importance of the message has changed. More...

(void)	- messageDidChangeCapabilities:
	Called to report that one or more of the capabilities of the message has changed. More...

(void)	- message:didChangeIsCoalescedStatus:
	Called to report that the message's coalesced status has changed in response to receiving additional messages. More...

(void)	- message:didChangeIsReadStatus:
	Called to report that the "is read" status of the message has changed. More...

Detailed Description

Delegate that can be used to retrieve status updates for a message.

Delegate can be registered to retrieve status updates on the messages’ various attributes.

Method Documentation

- (void) message:	(CSMessage *)	message
didChangeBody:	(NSString *)	body

Called to report that the message's body text has changed in response to a local setBodyAndReportTyping:completionHandler: (CSMessage) operation.

Parameters

message	The message for which the body has changed.
body	the new value of the body.

See also: CSMessage::body

- (void) message:	(CSMessage *)	message
didChangeDeliveryState:	(CSMessagingMessageDeliveryState)	state

Called to report that the delivery state of the message has changed.

Parameters

message	The CSMessage for which the "delivery" state has changed.
state	the new value of the delivery state.

See also: CSMessagingMessageDeliveryState

- (void) message:	(CSMessage *)	message
didChangeDoNotForwardStatus:	(BOOL)	doNotForward

Called to report that the "do not forward" status of the message has changed.

Parameters

message	The CSMessage for which the "do not forward" status has changed.
doNotForward	The new value of the do-not-forward flag.

See also: CSMessage::doNotForward

- (void) message:	(CSMessage *)	message
didChangeHasAttachmentStatus:	(BOOL)	hasAttachment

Called to report that the list of attachments associated with the message has changed.

Parameters

message	The message for which the hasAttachment has changed.
hasAttachment	The new value of the hasAttachment flag.

- (void) message:	(CSMessage *)	message
didChangeHasUnreadAttachmentStatus:	(BOOL)	hasUnreadAttachment

Called to report that the unread attachment status of the message has changed.

Parameters

message	The CSMessage for which the unread attachment status has changed.
hasUnreadAttachment	The new value of the hasUnreadAttachment flag.

See also: CSMessage::hasUnreadAttachment

- (void) message:	(CSMessage *)	message
didChangeImportance:	(CSMessagingImportance)	importance

Called to report that the importance of the message has changed.

Parameters

message	The CSMessage for which the importance has changed.
importance	The new value of the importance level.

See also: CSMessage::importance; CSMessagingImportance

- (void) message:	(CSMessage *)	message
didChangeInReplyTo:	(CSMessage *)	newMessage

Called to report that the message's in-reply-to attribute has changed in response to a local setInReplyTo:completionHandler: (CSMessage) operation.

Parameters

message	The message for which the in-reply-to attribute has changed.
newMessage	The new in-reply-to message.

See also: CSMessage::hasInReplyTo; - getInReplyToMessageWithCompletionHandler: (CSMessage)

- (void) message:	(CSMessage *)	message
didChangeIsCoalescedStatus:	(BOOL)	isCoalesced

optional

Called to report that the message's coalesced status has changed in response to receiving additional messages.

Parameters

message	The message for which the coalesced status has changed.
isCoalesced	The new value of the isCoalesced flag.

See also: CSMessage::coalesced

Deprecated:: THIS METHOD WILL BE REMOVED IN RELEASE VERSION 3.3.

- (void) message:	(CSMessage *)	message
didChangeIsReadStatus:	(BOOL)	isRead

optional

Called to report that the "is read" status of the message has changed.

Parameters

message	The message for which the "is read" status has changed.
isRead	The new value of the isRead flag.

See also: CSMessage::read

Deprecated:: use CSMessageDelegate::message:didChangeReadState: selector instead.

- (void) message:	(CSMessage *)	message
didChangeLastModifiedDate:	(NSDate *)	date

Called to report that the last modified date attribute of the message has changed.

Parameters

message	The message for which the last modified date has changed.
date	The new date.

See also: CSMessage::lastModifiedDate

- (void) message:	(CSMessage *)	message
didChangeReadState:	(CSMessagingMessageReadState)	state

Called to report that the read state of the message has changed.

Parameters

message	The CSMessage for which the "read" state has changed.
state	the new value of the read state.

See also: CSMessage::readState

- (void) message:	(CSMessage *)	message
didChangeStatus:	(CSMessagingMessageStatus)	status

Called to report that the status of the message has changed.

Parameters

message	The CSMessage for which the status has changed.
status	The new value of the message status.

See also: CSMessage::status

- (void) messageDidChangeCapabilities: (CSMessage *) message

Called to report that one or more of the capabilities of the message has changed.

The application should query each of the capabilities and enable/disable elements of the user interface based on the new capability settings. Capabilities can change as a result of local or remote actions.

Parameters

message The CSMessage that the callback is associated with.

See also: CSCapability; CSMessage::removeCapability; CSMessage::createAttachmentCapability; CSMessage::markAsReadCapability; CSMessage::sendCapability; CSMessage::updateBodyCapability; CSMessage::updateDoNotForwardCapability; CSMessage::updateImportanceCapability; CSMessage::updateInReplyToCapability

The documentation for this protocol was generated from the following file:

CSMessage.h

Instance Methods

Detailed Description

Method Documentation