Avaya Client Services API Reference (Windows)
Avaya Client Services API Reference (Windows)
Avaya.ClientServices
SearchConversation Class
SearchConversation Properties
SearchConversation Methods
SearchConversation Events

SearchConversation Class

Interface for conversation returned from MessagingService.SearchConversations operation.
Inheritance Hierarchy
System
Object
Avaya.ClientServices
Conversation
Avaya.ClientServices
SearchConversation

Namespace: Avaya.ClientServices
Assembly: AvayaClientServices (in AvayaClientServices.dll) Version: 592.1.30.0
Syntax
C#
Copy

    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 Conversation ActiveParticipants.)
| AddParticipantsCapability | Returns a Capability object that indicates if new participants can be added to the conversation. (Overrides Conversation AddParticipantsCapability.)
| 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 Conversation ComposingParticipants.)
| CreateMessageCapability | Returns a Capability object that indicates if a new message can be created in the conversation. (Overrides Conversation CreateMessageCapability.)
| HasAttachments | Returns true if the conversation has any attachments on any of its messages. (Overrides Conversation HasAttachments.)
| HasUnreadAttachments | Returns true if the conversation has any unread attachments. (Overrides Conversation HasUnreadAttachments.)
| HasUnreadMessages | Returns true if the conversation has any unread messages. (Overrides Conversation HasUnreadMessages.)
| HasUnreadMessagesSinceLastAccess | Returns whether the conversation has unread messages since the time the conversation was last accessed. (Overrides Conversation HasUnreadMessagesSinceLastAccess.)
| Id | Returns the unique conversation identifier. (Overrides Conversation Id.)
| IsActive | Returns true if the conversation is active. (Overrides Conversation IsActive.)
| IsClosed | Returns true if the conversation is closed. (Overrides Conversation IsClosed.)
| 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 Conversation IsMultiParty.)
| IsPrivate | Returns true if the conversation is private (i.e. the Sensitivity of the conversation is set to Private. (Overrides Conversation IsPrivate.)
| IsTypingCapability | Returns a Capability object that indicates if typing status reporting is available. (Overrides Conversation IsTypingCapability.)
| LastAccessedTime | Returns the time the conversation was last accessed. (Overrides Conversation LastAccessedTime.)
| LastEntryTime | Returns the last entry timestamp of the conversation. This is the timestamp of the most recent message in the conversation. (Overrides Conversation LastEntryTime.)
| LastUpdatedByParticipant | Returns the last participant that updated this conversation. (Overrides Conversation LastUpdatedByParticipant.)
| LastUpdatedTime | Returns the time the conversation was last updated. (Overrides Conversation LastUpdatedTime.)
| LeaveCapability | Returns a Capability object that indicates if the conversation can be left. (Overrides Conversation LeaveCapability.)
| MarkAllContentAsReadCapability | Returns a Capability object that indicates if all messages in the conversation can be marked as read. (Overrides Conversation MarkAllContentAsReadCapability.)
| 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 Conversation OlderContentCapability.)
| Participants | Gets a list of participants contained in this conversation. (Overrides Conversation Participants.)
| PreviewText | Returns the preview text of the conversation. (Overrides Conversation PreviewText.)
| 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 Conversation ProviderConversationId.)
| ProviderType | Gets a provider type for the conversation. (Overrides Conversation ProviderType.)
| RemoveCapability | Returns a Capability object that indicates if the conversation can be removed. (Overrides Conversation RemoveCapability.)
| 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 Conversation RemoveParticipantsCapability.)
| Sensitivity | Returns the sensitivity of the conversation. (Overrides Conversation Sensitivity.)
| StartCapability | Returns a Capability object that indicates if the conversation can be started. (Overrides Conversation StartCapability.)
| Status | Returns the server reconciled status of the conversation. (Overrides Conversation Status.)
| Subject | Returns the subject of the conversation if one is provided by the server. (Overrides Conversation Subject.)
| TotalAttachmentCount | Returns the total number of attachments in all messages of the conversation. (Overrides Conversation TotalAttachmentCount.)
| TotalMessageCount | Returns the total number of messages in the conversation. (Overrides Conversation TotalMessageCount.)
| Type | Returns the conversation type. (Overrides Conversation Type.)
| UnreadAttachmentCount | Returns the total number of unread attachments in all messages of the conversation. (Overrides Conversation UnreadAttachmentCount.)
| UnreadMessageCount | Returns the number of unread messages in the conversation. (Overrides Conversation UnreadMessageCount.)
| UpdateLastAccessTimeCapability | Returns a Capability object that indicates if the last accessed time of the conversation can be updated. (Overrides Conversation UpdateLastAccessTimeCapability.)
| UpdateSensitivityCapability | Returns a Capability object that indicates if the sensitivity of the conversation can be updated. (Overrides Conversation UpdateSensitivityCapability.)
| UpdateSubjectCapability | Returns a Capability object that indicates if the subject property of the conversation can be updated. (Overrides Conversation UpdateSubjectCapability.)
| UpdateTypeCapability | Returns a Capability object that indicates if the type of the conversation can be updated. (Overrides Conversation UpdateTypeCapability.)

Top
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 Conversation AddParticipantAddresses(List String , Conversation AddParticipantAddressesCompletionHandler).)
| ClearLocalAttachmentData | Clear conversation local attachment data. (Overrides Conversation ClearLocalAttachmentData(Conversation CompletionHandler).)
| CreateMessage | Creates a new Message in this conversation. (Overrides Conversation CreateMessage .)
| 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 Conversation IsParticipantActive(MessagingParticipant).)
| Leave | Invokes a leave request for this conversation. (Overrides Conversation Leave(Conversation CompletionHandler).)
| MarkAllContentAsRead | Marks all content in this conversation as read. (Overrides Conversation MarkAllContentAsRead(Conversation CompletionHandler).)
| RemoveMessage | Removes a Message (only draft messages can be removed). (Overrides Conversation RemoveMessage(Message, Conversation CompletionHandler).)
| 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 Conversation RemoveParticipantAddresses(List String , Conversation CompletionHandler).)
| 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 Conversation RetrieveMessages(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 Conversation RetrieveMessagesAfter(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 Conversation RetrieveMessagesBefore(UInt32, Message).)
| SetLastAccessTime | Invokes a set last access time request for this conversation. (Overrides Conversation SetLastAccessTime(Conversation CompletionHandler).)
| SetSensitivity | Sets the conversation sensitivity. (Overrides Conversation SetSensitivity(SensitivityLevel, Conversation CompletionHandler).)
| SetSubject | Sets the subject for this conversation. (Overrides Conversation SetSubject(String, Conversation CompletionHandler).)
| SetType | Sets the conversation type. (Overrides Conversation SetType(ConversationType, Conversation CompletionHandler).)
| Start | Invokes a start request for this conversation. (Overrides Conversation Start(Conversation CompletionHandler).)

Top
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 Conversation ComposingParticipantsChanged.)
| 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(Conversation CompletionHandler) 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.

Top
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

#### Reference

Avaya.ClientServices Namespace

© 2017 Avaya LLC. All Rights Reserved.