| SearchConversation Class |
Interface for conversation returned from MessagingService.SearchConversations operation.
Inheritance HierarchyNamespace: Avaya.ClientServices
Assembly: AvayaClientServices (in AvayaClientServices.dll) Version: 493.0.70.0
SyntaxC#
public class SearchConversation : Conversation
The SearchConversation type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | ActiveParticipants |
Gets a list of active participants contained in this conversation.
(Overrides ConversationActiveParticipants.) |
| AddParticipantsCapability |
Returns a Capability object that indicates if new participants can be added to the conversation.
(Overrides ConversationAddParticipantsCapability.) |
| BaseConversation |
Returns reference to the conversation object corresponding to this search conversation.
If the underlying conversation is active and exists on the conversations list
returned reference will point to the same object that exists on the conversations list.
|
| ComposingParticipants |
Gets a list of composing participants contained in this conversation.
(Overrides ConversationComposingParticipants.) |
| CreateMessageCapability |
Returns a Capability object that indicates if a new message can be created in the conversation.
(Overrides ConversationCreateMessageCapability.) |
| HasAttachments |
Returns true if the conversation has any attachments on any of its messages.
(Overrides ConversationHasAttachments.) |
| HasUnreadAttachments |
Returns true if the conversation has any unread attachments.
(Overrides ConversationHasUnreadAttachments.) |
| HasUnreadMessages |
Returns true if the conversation has any unread messages.
(Overrides ConversationHasUnreadMessages.) |
| HasUnreadMessagesSinceLastAccess |
Returns whether the conversation has unread messages since the time the conversation was last accessed.
(Overrides ConversationHasUnreadMessagesSinceLastAccess.) |
| Id |
Returns the unique conversation identifier.
(Overrides ConversationId.) |
| IsActive |
Returns true if the conversation is active.
(Overrides ConversationIsActive.) |
| IsClosed |
Returns true if the conversation is closed.
(Overrides ConversationIsClosed.) |
| IsMultiParty |
Returns 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.
(Overrides ConversationIsMultiParty.) |
| IsPrivate |
Returns true if the conversation is private (i.e. the Sensitivity of the conversation
is set to Private.
(Overrides ConversationIsPrivate.) |
| IsTypingCapability |
Returns a Capability object that indicates if typing status reporting is available.
(Overrides ConversationIsTypingCapability.) |
| LastAccessedTime |
Returns the time the conversation was last accessed.
(Overrides ConversationLastAccessedTime.) |
| LastEntryTime |
Returns the last entry timestamp of the conversation. This is the timestamp of the most
recent message in the conversation.
(Overrides ConversationLastEntryTime.) |
| LastUpdatedByParticipant |
Returns the last participant that updated this conversation.
(Overrides ConversationLastUpdatedByParticipant.) |
| LastUpdatedTime |
Returns the time the conversation was last updated.
(Overrides ConversationLastUpdatedTime.) |
| LeaveCapability |
Returns a Capability object that indicates if the conversation can be left.
(Overrides ConversationLeaveCapability.) |
| MarkAllContentAsReadCapability |
Returns a Capability object that indicates if all messages in the conversation can be marked as read.
(Overrides ConversationMarkAllContentAsReadCapability.) |
| MessageDeliveryStateCapability |
Returns a Capability indicating whether this conversation is capable of reporting delivery state updates for sent messages.
(Inherited from Conversation.) |
| MessageReadStateCapability |
Returns a Capability indicating whether this conversation is capable of reporting read state updates for sent messages.
(Inherited from Conversation.) |
| OlderContentCapability |
Returns a Capability object that indicates whether the user can "scroll to get more messages".
i.e. there are additional messages not yet downloaded from the server.
(Overrides ConversationOlderContentCapability.) |
| Participants |
Gets a list of participants contained in this conversation.
(Overrides ConversationParticipants.) |
| PreviewText |
Returns the preview text of the conversation.
(Overrides ConversationPreviewText.) |
| ProviderConversationId |
Returns 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.
(Overrides ConversationProviderConversationId.) |
| ProviderType |
Gets a provider type for the conversation.
(Overrides ConversationProviderType.) |
| RemoveCapability |
Returns a Capability object that indicates if the conversation can be removed.
(Overrides ConversationRemoveCapability.) |
| RemoveParticipantCapability |
Returns a Capability object that indicates if a participant can be removed from the conversation.
(Inherited from Conversation.) |
| RemoveParticipantsCapability |
Returns a Capability object that indicates if participants can be removed from the conversation.
(Overrides ConversationRemoveParticipantsCapability.) |
| Sensitivity |
Returns the sensitivity of the conversation.
(Overrides ConversationSensitivity.) |
| StartCapability |
Returns a Capability object that indicates if the conversation can be started.
(Overrides ConversationStartCapability.) |
| Status |
Returns the server reconciled status of the conversation.
(Overrides ConversationStatus.) |
| Subject |
Returns the subject of the conversation if one is provided by the server.
(Overrides ConversationSubject.) |
| TotalAttachmentCount |
Returns the total number of attachments in all messages of the conversation.
(Overrides ConversationTotalAttachmentCount.) |
| TotalMessageCount |
Returns the total number of messages in the conversation.
(Overrides ConversationTotalMessageCount.) |
| Type |
Returns the conversation type.
(Overrides ConversationType.) |
| UnreadAttachmentCount |
Returns the total number of unread attachments in all messages of the conversation.
(Overrides ConversationUnreadAttachmentCount.) |
| UnreadMessageCount |
Returns the number of unread messages in the conversation.
(Overrides ConversationUnreadMessageCount.) |
| UpdateLastAccessTimeCapability |
Returns a Capability object that indicates if the last accessed time of the conversation can be updated.
(Overrides ConversationUpdateLastAccessTimeCapability.) |
| UpdateSensitivityCapability |
Returns a Capability object that indicates if the sensitivity of the conversation can be updated.
(Overrides ConversationUpdateSensitivityCapability.) |
| UpdateSubjectCapability |
Returns a Capability object that indicates if the subject property of the conversation can be updated.
(Overrides ConversationUpdateSubjectCapability.) |
| UpdateTypeCapability |
Returns a Capability object that indicates if the type of the conversation can be updated.
(Overrides ConversationUpdateTypeCapability.) |
Methods| Name | Description | |
|---|---|---|
 | AddParticipant |
Invokes an add participant request for this conversation for contact object.
(Inherited from Conversation.) |
| AddParticipantAddresses |
Invokes an add participant request for this conversation for each of the provided addresses.
(Overrides ConversationAddParticipantAddresses(ListString, ConversationAddParticipantAddressesCompletionHandler).) |
| ClearLocalAttachmentData |
Clear conversation local attachment data.
(Overrides ConversationClearLocalAttachmentData(ConversationCompletionHandler).) |
| CreateMessage |
Creates a new Message in this conversation.
(Overrides ConversationCreateMessage.) |
| GetSearchMessages |
Gets a list of the messages contained in this conversation. This list represents
all messages which have been, or are being, downloaded. This is not necessarily the entire
historical message content of the conversation.
|
| IsParticipantActive |
Returns true if a specified participant is active in this conversation.
(Overrides ConversationIsParticipantActive(MessagingParticipant).) |
| Leave |
Invokes a leave request for this conversation.
(Overrides ConversationLeave(ConversationCompletionHandler).) |
| MarkAllContentAsRead |
Marks all content in this conversation as read.
(Overrides ConversationMarkAllContentAsRead(ConversationCompletionHandler).) |
| RemoveMessage |
Removes a Message (only draft messages can be removed).
(Overrides ConversationRemoveMessage(Message, ConversationCompletionHandler).) |
| RemoveParticipant |
Invokes a remove participant request for this conversation.
(Inherited from Conversation.) |
| RemoveParticipantAddresses |
Invokes a remove participant request for this conversation for each of the provided addresses.
(Overrides ConversationRemoveParticipantAddresses(ListString, ConversationCompletionHandler).) |
| RetrieveMessages |
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.
(Overrides ConversationRetrieveMessages(MessageRetrievalWatcher).) |
| RetrieveMessagesAfter |
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.
(Overrides ConversationRetrieveMessagesAfter(UInt32, Message).) |
| RetrieveMessagesBefore |
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.
(Overrides ConversationRetrieveMessagesBefore(UInt32, Message).) |
| SetLastAccessTime |
Invokes a set last access time request for this conversation.
(Overrides ConversationSetLastAccessTime(ConversationCompletionHandler).) |
| SetSensitivity |
Sets the conversation sensitivity.
(Overrides ConversationSetSensitivity(SensitivityLevel, ConversationCompletionHandler).) |
| SetSubject |
Sets the subject for this conversation.
(Overrides ConversationSetSubject(String, ConversationCompletionHandler).) |
| SetType |
Sets the conversation type.
(Overrides ConversationSetType(ConversationType, ConversationCompletionHandler).) |
| Start |
Invokes a start request for this conversation.
(Overrides ConversationStart(ConversationCompletionHandler).) |
Events| Name | Description | |
|---|---|---|
 | ActiveStatusChanged |
Notifies the application that the conversation's active status has changed in response to a local
or remote operation.
|
| ClosedStatusChanged |
Notifies the application that the conversation's closed status has changed in response to a local
or remote operation.
|
| ComposingParticipantsChanged |
Occurs when the list of remote participants that are currently composing a message is changed.
(Overrides ConversationComposingParticipantsChanged.) |
| ConversationCapabilitiesChanged |
Notifies the application that one or more of the capabilities of the conversation 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.
|
| LastAccessTimeChanged |
Notifies the application that the last accessed time of the conversation has changed in response to
messages in the conversation being marked as read, or by an explicit invocation of the
SetLastAccessTime(ConversationCompletionHandler) method.
|
| LastEntryTimeChanged |
Notifies the application that the last entry time of the conversation has changed in response to
new messages being added to the conversation.
|
| LastUpdateTimeChanged |
Notifies the application that the last updated time of the conversation has changed.
|
| MessagesAdded |
Notifies the application that one or more messages have been added to the conversation.
|
| MessagesDeleted |
Notifies the application that one or more messages have been removed from the conversation.
|
| MultiPartyStatusChanged |
Notifies the application that the conversation's multi-party status has changed in response to
new participants being added or existing participants being removed.
|
| ParticipantsAdded |
Notifies the application that one or more participants have been added to the conversation.
|
| ParticipantsRemoved |
Notifies the application that one or more participants have been removed from the conversation.
|
| PreviewTextChanged |
Notifies the application that the preview text for the conversation has changed.
|
| SensitivityChanged |
Notifies the application that the sensitivity of the conversation has changed via either a
local or remote operation.
|
| StatusChanged |
Notifies the application that the status of the conversation has changed.
|
| SubjectChanged |
Notifies the application that the subject of the conversation has changed via either a
local or remote operation.
|
| TotalAttachmentCountChanged |
Notifies the application that the total number of attachments in the conversation has changed.
|
| TotalMessageCountChanged |
Notifies the application that the total number of messages in the conversation has changed.
|
| TotalUnreadAttachmentCountChanged |
Notifies the application that the total number of unread attachments in the conversation has changed.
|
| TotalUnreadMessageCountChanged |
Notifies the application that the number of unread messages in the conversation has changed.
|
Remarks
This is conversation object used for instances returned by search operation. The difference
is that the messages of this conversation are not stored in the main data model, that is
returned in DataRetrievals.
See Also