Avaya Client Services API Reference (OS X)
Instance Methods | Properties | List of all members
CSMessagingConversation Class Reference

Interface for all conversation related tasks and properties. More...

#import <CSMessagingConversation.h>

Inherits NSObject.

Inherited by CSMessagingSearchConversation.

Instance Methods

(BOOL) - isParticipantActive:
 Returns YES if a specified participant is active in this conversation. More...
 
(CSMessage *) - createMessage
 Creates a new message in this conversation. More...
 
(void) - removeMessage:completionHandler:
 Removes a CSMessage (only draft messages can be removed). More...
 
(void) - startWithCompletionHandler:
 Invokes a start request for this conversation. More...
 
(void) - addParticipantWithContact:completionHandler:
 Invokes an add participant request for this conversation for provided contact object. More...
 
(void) - addParticipantAddresses:completionHandler:
 Invokes an add participant request for this conversation for each of the provided addresses. More...
 
(void) - removeParticipantAddresses:completionHandler:
 Invokes a remove participant request for this conversation for each of the provided addresses. More...
 
(void) - removeParticipant:completionHandler:
 Invokes a remove participant request for this conversation. More...
 
(void) - addParticipants:completionHandler:
 Adds participants. More...
 
(void) - retrieveMessagesWithWatcher:
 Starts the retrieval of messages associated with this conversation. More...
 
(void) - retrieveMessagesAfterMessage:maxCount:
 Retrieves a list of the conversation messages after the specified message. More...
 
(void) - retrieveMessagesBeforeMessage:maxCount:
 Retrieves a list of the conversation messages before the specified message. More...
 
(void) - updateLastAccessTimeWithCompletionHandler:
 Invokes a set last access time request for this conversation. More...
 
(void) - setSubject:completionHandler:
 Sets the subject for this conversation. More...
 
(void) - setSensitivity:completionHandler:
 Set conversation sensitivity level. More...
 
(void) - setType:completionHandler:
 Sets the conversation type. More...
 
(void) - leaveWithCompletionHandler:
 Invokes a leave request for this conversation. More...
 
(void) - clearLocalAttachmentDataWithCompletionHandler:
 Clear conversation local attachment data. More...
 
(void) - markAllContentAsReadWithCompletionHandler:
 Marks all content in this conversation as read. More...
 

Properties

id< CSMessagingConversationDelegatedelegate
 The delegate responsible for handling conversation events. More...
 
id< CSMessagingComposingParticipantsWatcherDelegatecomposingParticipantsWatcherDelegate
 The delegate responsible for handling messages signalling a change in the list of composing participants. More...
 
NSString * conversationId
 The unique conversation identifier. More...
 
NSString * providerConversationId
 This is the conversation ID from the underlying provider (e.g., the AMM server) as-is. More...
 
CSMessagingSensitivityLevel sensitivity
 The sensitivity of the conversation. More...
 
BOOL active
 A Boolean value indicating whether the conversation is active. More...
 
BOOL closed
 A Boolean value indicating whether the conversation is closed. More...
 
BOOL multiParty
 The multi-party status of the conversation. More...
 
BOOL privateConversation
 The conversation is private when the sensitivity of the conversation is set to CSMessagingSensitivityLevelPrivate. More...
 
BOOL hasUnreadMessagesSinceLastAccess
 A Boolean value indicating whether the conversation has unread messages since the time the conversation was last accessed. More...
 
BOOL hasUnreadMessages
 A Boolean value indicating whether the conversation has any unread messages. More...
 
BOOL hasUnreadAttachments
 A Boolean value indicating whether the conversation has any unread attachments. More...
 
BOOL hasAttachments
 A Boolean value indicating whether the conversation has any attachments on any of its messages. More...
 
NSDate * lastAccessDate
 The date the conversation was last accessed. More...
 
NSDate * lastUpdatedDate
 The date the conversation was last updated. More...
 
NSDate * latestEntryDate
 The last entry timestamp of the conversation. More...
 
NSArray * composingParticipants
 An array of composing participants contained in this conversation. More...
 
NSArray * allParticipants
 A list of participants contained in this conversation. More...
 
NSArray * activeParticipants
 A list of active participants contained in this conversation. More...
 
CSMessagingConversationType type
 The conversation type. More...
 
NSString * previewText
 The preview text of the conversation. More...
 
NSUInteger totalMessageCount
 The total number of messages in the conversation. More...
 
NSUInteger attachmentCount
 The total number of attachments in all messages of the conversation. More...
 
NSUInteger unreadAttachmentCount
 The total number of unread attachments in all messages of the conversation. More...
 
NSUInteger unreadMessageCount
 The number of unread messages in the conversation. More...
 
NSString * subject
 The subject of the conversation if one is provided by the server. More...
 
CSMessagingParticipantlastUpdatedByParticipant
 The last CSMessagingParticipant that updated this conversation. More...
 
CSMessagingConversationStatus status
 The server reconciled status of the conversation. More...
 
CSCapabilityupdateSubjectCapability
 A CSCapability object that indicates if the subject property of the conversation can be updated. More...
 
CSCapabilityupdateLastAccessedTimeCapability
 A CSCapability object that indicates if the type of the conversation can be updated. More...
 
CSCapabilityupdateSensitivityCapability
 A CSCapability object that indicates if the sensitivity of the conversation can be updated. More...
 
CSCapabilityupdateTypeCapability
 A CSCapability object that indicates if the type of the conversation can be updated. More...
 
CSCapabilityolderContentCapability
 A CSCapability object that indicates whether the user can "scroll to get more messages", i.e. More...
 
CSCapabilityaddParticipantsCapability
 A CSCapability object that indicates if new participants can be added to the conversation. More...
 
CSCapabilityremoveParticipantsCapability
 A CSCapability object that indicates if participants can be removed from the conversation. More...
 
CSCapabilityremoveParticipantCapability
 A CSCapability object that indicates if a participant can be removed from the conversation. More...
 
CSCapabilitycreateMessageCapability
 A CSCapability object that indicates if a new message can be created in the conversation. More...
 
CSCapabilitymarkAllContentAsReadCapability
 A CSCapability object that indicates if all messages in the conversation can be marked as read. More...
 
CSCapabilityleaveCapability
 A CSCapability object that indicates if the conversation can be left. More...
 
CSCapabilitystartCapability
 A CSCapability object that indicates if the conversation can be started. More...
 
CSCapabilityremoveCapability
 A CSCapability object that indicates if the conversation can be removed. More...
 
CSCapabilityisTypingCapability
 A CSCapability object that indicates if typing status reporting is avaliable. More...
 
CSCapabilitymessageReadStateCapability
 Returns a capability indicating whether this conversation is capable of reporting read state updates for sent messages. More...
 
CSCapabilitymessageDeliveryStateCapability
 Returns a capability indicating whether this conversation is capable of reporting delivery state updates for sent messages. More...
 
CSMessagingProviderType providerType
 A CSMessagingProviderType object that contains information about source of the conversation. More...
 

Detailed Description

Interface for all conversation related tasks and properties.

A conversation is managing a list of messages which are sent between its participants.

Beside messages, a conversation also contains a lot of its own parameters. Almost all of them can be set only before it is published. After that, one can only send a message, add a new participant, change subject, etc.

It is important to understand that all conversation participants have the same privileges. Once the first user starts a conversation it cannot be closed by that user; every user can leave only by themselves, and add new participants as desired.

After creating new conversation object call addParticipantAddresses:completionHandler: (CSMessagingConversation) method for adding new participants. Before sending first message set all other required parameters, like Subject and call startWithCompletionHandler: (CSMessagingConversation) method.

Method Documentation

- (void) addParticipantAddresses: (NSArray *)  addressesToAdd
completionHandler: (CSMessagingParticipantsChangedCompletionHandler handler 

Invokes an add participant request for this conversation for each of the provided addresses.

Parameters
addressesToAdd- NSArray of NSStrings representing the participant addresses to add
handlerCSMessagingParticipantsChangedCompletionHandler for this operation.
See also
addParticipantsCapability
- (void) addParticipants: (NSArray *)  participantsToAdd
completionHandler: (CSMessagingParticipantsChangedCompletionHandler handler 

Adds participants.

Parameters
participantsToAddNSArray of CSMessagingParticipant(s) to add
handlerThe completion handler associated with this operation
See also
addParticipantsCapability
- (void) addParticipantWithContact: (CSContact *)  contact
completionHandler: (CSMessagingParticipantsChangedCompletionHandler handler 

Invokes an add participant request for this conversation for provided contact object.

Parameters
contact- Contact representing the participant to add
handlerCSMessagingParticipantsChangedCompletionHandler for this operation.
See also
addParticipantsCapability
- (void) clearLocalAttachmentDataWithCompletionHandler: (CSMessagingCompletionHandler handler

Clear conversation local attachment data.

This method clears only application data and it is not applicable to any content downloaded to a user’s device.

Parameters
handlerCSMessagingCompletionHandler for this operation.
- (CSMessage *) createMessage

Creates a new message in this conversation.

Returns
A new CSMessage object, or nil if a new message could not be created.
See also
createMessageCapability
- (BOOL) isParticipantActive: (CSMessagingParticipant *)  messagingParticipant

Returns YES if a specified participant is active in this conversation.

Parameters
messagingParticipantthe participant to query for
Returns
YES if the specified participant is an active participant of the conversation.
- (void) leaveWithCompletionHandler: (CSMessagingCompletionHandler handler

Invokes a leave request for this conversation.

After leaving, participant can no longer contribute to the conversation unless he is added once again.

When last participant is leaving the conversation it will become closed after a while.

Parameters
handlerCSMessagingCompletionHandler for this operation.
See also
leaveCapability
- (void) markAllContentAsReadWithCompletionHandler: (CSMessagingCompletionHandler handler

Marks all content in this conversation as read.

Parameters
handlerCSMessagingCompletionHandler for this operation.
See also
-[markAllContentAsReadCapability]
- (void) removeMessage: (CSMessage *)  messageToRemove
completionHandler: (CSMessagingCompletionHandler handler 

Removes a CSMessage (only draft messages can be removed).

Parameters
messageToRemoveThe CSMessage to be removed.
handlerCSMessagingCompletionHandler for this operation.
- (void) removeParticipant: (CSMessagingParticipant *)  messagingParticipant
completionHandler: (CSMessagingParticipantsChangedCompletionHandler handler 

Invokes a remove participant request for this conversation.

Parameters
messagingParticipantthe participant to remove from this conversation.
handlerCSMessagingParticipantsChangedCompletionHandler for this operation.
See also
removeParticipantCapability
- (void) removeParticipantAddresses: (NSArray *)  addressesToRemove
completionHandler: (CSMessagingParticipantsChangedCompletionHandler handler 

Invokes a remove participant request for this conversation for each of the provided addresses.

Parameters
addressesToRemove- NSArray of NSStrings representing the participant addresses to remove
handlerCSMessagingParticipantsChangedCompletionHandler for this operation.
See also
removeParticipantsCapability
- (void) retrieveMessagesAfterMessage: (CSMessage *)  message
maxCount: (NSUInteger)  maxMessagesToRetrieve 

Retrieves a list of the conversation messages after the specified message.

This list represents a list of contiguous messages which have been, or are being, downloaded.

This method is used in conjunction with the retrieveMessagesWithWatcher: method to retrieve older message content associated with the conversation. Please refer to the description of that method for detailed usage information.

To determine when it is appropriate to call the retrieveMessagesAfter method, the client application should query the olderContentCapability method.

Parameters
maxMessagesToRetrievethe maximum number of messages to retrieve. The actual number retrieved may be less than this if the maximum number of messages allowed per retrieval request, as configured on the server, is less than the specified value, or if the end of the message list is reached.
messagethe starting point in the retrieval. Messages immediately after this one will be retrieved.
See also
- retrieveMessagesWithWatcher:
- retrieveMessagesBeforeMessage:maxCount:
- (void) retrieveMessagesBeforeMessage: (CSMessage *)  message
maxCount: (NSUInteger)  maxMessagesToRetrieve 

Retrieves a list of the conversation messages before the specified message.

This list represents a list of contiguous messages which have been, or are being, downloaded.

This method is used in conjunction with the retrieveMessagesWithWatcher: method to retrieve older message content associated with the conversation. Please refer to the description of that method for detailed usage information.

To determine when it is appropriate to call the retrieveMessagesBefore method, the client application should query the olderContentCapability method.

Parameters
maxMessagesToRetrieveThe maximum number of messages to retrieve. The actual number retrieved may be less than this if the maximum number of messages allowed per retrieval request, as configured on the server is less than the specified value, or if the start of the message list is reached.
messagethe starting point in the retrieval. Messages immediately before this one will be retrieved.
See also
- retrieveMessagesWithWatcher:
- retrieveMessagesAfterMessage:maxCount:
- (void) retrieveMessagesWithWatcher: (CSDataRetrievalWatcher *)  watcher

Starts the retrieval of messages associated with this conversation.

This initial retrieval represents the most recent messages in the conversation and is limited to a maximum number that is specified by the messaging server. This is not necessarily the entire historical message content of the conversation.

This method begins the retrieval of the dynamically-updated collection of messages associated with this conversation. Normally the client application will only need to call this method once to install a watcher object to monitor the initial download of messages and then continue to watch for updates to the collection.

If older messages are required to be downloaded, the retrieveMessagesBeforeMessage:maxCount: and/or retrieveMessagesAfterMessage:maxCount:] methods can be used to retrieve additional message history. Note, however, that retrieveMessagesWithWatcher: must be called first to install the CSDataRetrievalWatcher object that will monitor the retrieval, since these other methods work on a shared collection managed internally by the CSMessagingConversation object. The application should use the dataRetrievalWatcher:contentsDidChange:changedItems: (CSDataRetrievalWatcherDelegate-p) callback to build up and maintain a local collection of messages associated with this conversation.

When using these message retrieval methods, it is important to note that there can only be a single retrieval operation in progress at any given time. If there is a retrieval operation in progress when once of these three message retrieval methods are called, the currently running retrieval will be cancelled before starting the next operation.

If the client application calls this method additional times, no actual download of messages from the server occurs, but the watcher listener callbacks that report progress will fire (i.e. "progress" and "done" callbacks). However, no additions to the message collection will occur as a result of the subsequent calls. If a different watcher object is supplied in a subsequent call, the previous watcher object is "unlinked" from the underlying message object collection and will never receive any additional updates.

Parameters
watcherCSDataRetrievalWatcher object, created by the application, to track the progress of the requested operation.
See also
- retrieveMessagesBeforeMessage:maxCount:
- retrieveMessagesAfterMessage:maxCount:
- (void) setSensitivity: (CSMessagingSensitivityLevel sensitivity
completionHandler: (CSMessagingCompletionHandler handler 

Set conversation sensitivity level.

Parameters
sensitivityCSMessagingSensitivityLevel the new conversation sensitivity.
handlerCSMessagingCompletionHandler for this operation.
See also
updateSensitivityCapability
- (void) setSubject: (NSString *)  subject
completionHandler: (CSMessagingCompletionHandler handler 

Sets the subject for this conversation.

Parameters
subjectthe new subject of this conversation.
handlerThe Application/client context associated with this operation
See also
updateSubjectCapability
- (void) setType: (CSMessagingConversationType type
completionHandler: (CSMessagingCompletionHandler handler 

Sets the conversation type.

Parameters
typeCSMessagingConversationType the new conversation type.
handlerCSMessagingCompletionHandler for this operation.
See also
updateTypeCapability
- (void) startWithCompletionHandler: (CSMessagingCompletionHandler handler

Invokes a start request for this conversation.

Parameters
handlerCSMessagingCompletionHandler for this operation.
- (void) updateLastAccessTimeWithCompletionHandler: (CSMessagingCompletionHandler handler

Invokes a set last access time request for this conversation.

Parameters
handlerCSMessagingCompletionHandler for this operation.
See also
updateLastAccessedTimeCapability
lastAccessDate

Property Documentation

- (BOOL) active
readnonatomicassign

A Boolean value indicating whether the conversation is active.

An active conversation is one that allows new contributions from any of the current participants and has the local user as an active participant (i.e. the local user has not left the conversation).

- (NSArray*) activeParticipants
readnonatomicassign
- (CSCapability*) addParticipantsCapability
readnonatomicassign

A CSCapability object that indicates if new participants can be added to the conversation.

This capability is Allowed when all of the following conditions are true:

  • The messaging service is online (has an active connection to the server).
  • The Conversation is active (see active).
See also
- addParticipantAddresses:completionHandler:
- (NSArray*) allParticipants
readnonatomicassign
- (NSUInteger) attachmentCount
readnonatomicassign

The total number of attachments in all messages of the conversation.

See also
CSMessagingConversationDelegate messagingConversation:didChangeTotalAttachmentCount:
- (BOOL) closed
readnonatomicassign

A Boolean value indicating whether the conversation is closed.

A closed conversation prohibits new contributions (or activity of any kind) from any participants. Such conversations are candidates for being deleted (after backup) as part of storage management activities.

See also
- messagingConversation:didChangeClosedStatus: (CSMessagingConversationDelegate-p)
- (NSArray*) composingParticipants
readnonatomicassign

An array of composing participants contained in this conversation.

- (id<CSMessagingComposingParticipantsWatcherDelegate>) composingParticipantsWatcherDelegate
readwritenonatomicweak

The delegate responsible for handling messages signalling a change in the list of composing participants.

The application should set a delegate only when needed, to reduce the network traffic associated with updating the composing participants list. When no longer interested in this information (i.e. the user has left the conversation window), the application should set this delegate to nil to remove the installed delegate.

When there is no delegate set, the composingParticipants property will always return an empty array, since the lack of an installed delegate indicates that the application is not interested in this information.

- (NSString*) conversationId
readnonatomicassign

The unique conversation identifier.

- (CSCapability*) createMessageCapability
readnonatomicassign

A CSCapability object that indicates if a new message can be created in the conversation.

This capability is Allowed when all of the following conditions are true:

  • The messaging service is online (has an active connection to the server).
  • The conversation is in the draft state and has been started or is in the published state.
  • The Conversation does not have unsent messages.
  • The Conversation is not currently being left.
See also
- createMessage
- startWithCompletionHandler:
- (id<CSMessagingConversationDelegate>) delegate
readwritenonatomicweak

The delegate responsible for handling conversation events.

- (BOOL) hasAttachments
readnonatomicassign

A Boolean value indicating whether the conversation has any attachments on any of its messages.

See also
attachmentCount
- (BOOL) hasUnreadAttachments
readnonatomicassign

A Boolean value indicating whether the conversation has any unread attachments.

See also
unreadAttachmentCount
- (BOOL) hasUnreadMessages
readnonatomicassign

A Boolean value indicating whether the conversation has any unread messages.

See also
unreadMessageCount
- retrieveMessagesWithWatcher:
- (BOOL) hasUnreadMessagesSinceLastAccess
readnonatomicassign
- (CSCapability*) isTypingCapability
readnonatomicassign

A CSCapability object that indicates if typing status reporting is avaliable.

- (NSDate*) lastAccessDate
readnonatomicassign
- (CSMessagingParticipant*) lastUpdatedByParticipant
readnonatomicassign

The last CSMessagingParticipant that updated this conversation.

- (NSDate*) lastUpdatedDate
readnonatomicassign
- (NSDate*) latestEntryDate
readnonatomicassign

The last entry timestamp of the conversation.

This is the timestamp of the most recent message in the conversation.

See also
- messagingConversation:didChangeLatestEntryTime: (CSMessagingConversationDelegate-p)
- (CSCapability*) leaveCapability
readnonatomicassign

A CSCapability object that indicates if the conversation can be left.

This capability is Allowed when all of the following conditions are true:

  • The messaging service is online (has an active connection to the server).
  • The conversation is in the published state.
  • The conversation is not being left.
See also
- leaveWithCompletionHandler:
- (CSCapability*) markAllContentAsReadCapability
readnonatomicassign

A CSCapability object that indicates if all messages in the conversation can be marked as read.

This capability is Allowed when all of the following conditions are true:

  • The messaging service is online (has an active connection to the server).
  • The messaging server supports marking all conversation content as read.
  • The conversation is in the published state.
  • The conversation is not being left.
See also
- markAllContentAsReadWithCompletionHandler:
- (CSCapability*) messageDeliveryStateCapability
readnonatomicassign

Returns a capability indicating whether this conversation is capable of reporting delivery state updates for sent messages.

Returns
A CSCapability indicating whether this conversation is capable of reporting delivery state updates for sent messages.
- (CSCapability*) messageReadStateCapability
readnonatomicassign

Returns a capability indicating whether this conversation is capable of reporting read state updates for sent messages.

Returns
A CSCapability indicating whether this conversation is capable of reporting read state updates for sent messages.
- (BOOL) multiParty
readnonatomicassign

The multi-party status of the conversation.

A conversation is considered to be a multi-party conversation if there are more than two active participants in the conversation.

See also
- messagingConversation:didChangeMultiPartyStatus: (CSMessagingConversationDelegate-p)
- (CSCapability*) olderContentCapability
readnonatomicassign

A CSCapability object that indicates whether the user can "scroll to get more messages", i.e.

there are additional messages not yet downloaded from the server.

This capability is Allowed when all of the following conditions are true:

  • The messaging service is online (has an active connection to the server).
  • The conversation is in the published state.
  • The conversation is not currently being left.
See also
- retrieveMessagesAfterMessage:maxCount:
- retrieveMessagesBeforeMessage:maxCount:
- (NSString*) previewText
readnonatomicassign

The preview text of the conversation.

Preview text is a body of the latest message in the conversation.

See also
- messagingConversation:didChangePreviewText: (CSMessagingConversationDelegate-p)
- (BOOL) privateConversation
readnonatomicassign

The conversation is private when the sensitivity of the conversation is set to CSMessagingSensitivityLevelPrivate.

Returns
true if the conversation is private.
- (NSString*) providerConversationId
readnonatomicassign

This is the conversation ID from the underlying provider (e.g., the AMM server) as-is.

It will be consistent across clients and application launches, but is only guaranteed to be unique for conversations of that provider type. It will be empty for draft conversation.

- (CSMessagingProviderType) providerType
readnonatomicassign

A CSMessagingProviderType object that contains information about source of the conversation.

- (CSCapability*) removeCapability
readnonatomicassign

A CSCapability object that indicates if the conversation can be removed.

This capability is Allowed when the conversation is in draft state.

See also
- removeConversation:completionHandler: (CSMessagingService)
- (CSCapability*) removeParticipantCapability
readnonatomicassign

A CSCapability object that indicates if a participant can be removed from the conversation.

This capability is Allowed when one of the following conditions are true:

  • This conversation is in the draft state.
  • This conversation is published and messaging server allows to remove participants from it.
See also
- removeParticipant:completionHandler:
- (CSCapability*) removeParticipantsCapability
readnonatomicassign

A CSCapability object that indicates if participants can be removed from the conversation.

This capability is Allowed when the conversation is in draft state and is not transitioning to the published state.

See also
- removeParticipantAddresses:completionHandler:
- (CSMessagingSensitivityLevel) sensitivity
readwritenonatomicassign
- (CSCapability*) startCapability
readnonatomicassign

A CSCapability object that indicates if the conversation can be started.

This capability is Allowed when the conversation is in draft state and has not yet been started.

See also
- startWithCompletionHandler:
- (CSMessagingConversationStatus) status
readnonatomicassign

The server reconciled status of the conversation.

See also
- messagingConversation:didChangeStatus: (CSMessagingConversationDelegate-p)
- (NSString*) subject
readnonatomicassign

The subject of the conversation if one is provided by the server.

See also
CSMessagingConversationDelegate messagingConversation:didChangeSubject:
- setSubject:completionHandler:
- (NSUInteger) totalMessageCount
readnonatomicassign

The total number of messages in the conversation.

See also
CSMessagingConversationDelegate messagingConversation:didChangeTotalMessageCount:
- (CSMessagingConversationType) type
readwritenonatomicassign

The conversation type.

See also
CSMessagingConversationType
- (NSUInteger) unreadAttachmentCount
readnonatomicassign

The total number of unread attachments in all messages of the conversation.

See also
- messagingConversation:didChangeTotalUnreadAttachmentCount: (CSMessagingConversationDelegate-p)
- (NSUInteger) unreadMessageCount
readnonatomicassign
- (CSCapability*) updateLastAccessedTimeCapability
readnonatomicassign

A CSCapability object that indicates if the type of the conversation can be updated.

This capability is currently always disabled because the messaging server only supports conversations of type "thread".

This capability is Allowed when all of the following conditions are true:

  • The messaging service is online (has an active connection to the server).
  • The conversation is in a published state.
  • The conversation is not currently being left.
See also
- updateLastAccessTimeWithCompletionHandler:
- (CSCapability*) updateSensitivityCapability
readnonatomicassign

A CSCapability object that indicates if the sensitivity of the conversation can be updated.

This capability is Allowed when the conversation is in the draft state.

See also
- setSensitivity:completionHandler:
- (CSCapability*) updateSubjectCapability
readnonatomicassign

A CSCapability object that indicates if the subject property of the conversation can be updated.

This capability is Allowed when all of the following conditions are true:

  • The messaging service is online (has an active connection to the server).
  • The messaging server supports changing the subject of a conversation.
  • The conversation is active and is not transitioning between draft and published states.
  • The conversation is not currently being left.
See also
- setSubject:completionHandler:
active
- (CSCapability*) updateTypeCapability
readnonatomicassign

A CSCapability object that indicates if the type of the conversation can be updated.

This capability is currently always disabled because the messaging server only supports conversations of type "thread".

See also
- setType:completionHandler:

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