PersistentChatServices.BeginQueryChatHistory Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Overloads
| BeginQueryChatHistory(ICollection<Uri>, ChatHistoryQueryOptions, AsyncCallback, Object) |
Query the chat history for the specified collection of chat rooms, using the designated ChatHistoryQueryOptions. |
| BeginQueryChatHistory(ICollection<Uri>, String, Boolean, Boolean, AsyncCallback, Object) |
Query the chat history for the specified collection of chat rooms, using the designated search string and match options. |
BeginQueryChatHistory(ICollection<Uri>, ChatHistoryQueryOptions, AsyncCallback, Object)
Query the chat history for the specified collection of chat rooms, using the designated ChatHistoryQueryOptions.
public:
IAsyncResult ^ BeginQueryChatHistory(System::Collections::Generic::ICollection<Uri ^> ^ chatRooms, Microsoft::Rtc::Collaboration::PersistentChat::ChatHistoryQueryOptions ^ query, AsyncCallback ^ userCallback, System::Object ^ state);public IAsyncResult BeginQueryChatHistory (System.Collections.Generic.ICollection<Uri> chatRooms, Microsoft.Rtc.Collaboration.PersistentChat.ChatHistoryQueryOptions query, AsyncCallback userCallback, object state);member this.BeginQueryChatHistory : System.Collections.Generic.ICollection<Uri> * Microsoft.Rtc.Collaboration.PersistentChat.ChatHistoryQueryOptions * AsyncCallback * obj -> IAsyncResultPublic Function BeginQueryChatHistory (chatRooms As ICollection(Of Uri), query As ChatHistoryQueryOptions, userCallback As AsyncCallback, state As Object) As IAsyncResultParameters
- chatRooms
- ICollection<Uri>
The chat rooms to query.
- query
- ChatHistoryQueryOptions
The query.
- userCallback
- AsyncCallback
The method to be invoked when this asynchronous operation completes.
- state
- Object
An object to be passed back to the callback.
Returns
An IAsyncResult that references this operation.
Exceptions
query is null.
chatRooms collection is null or empty.
The PersistentChatEndpoint is not established.
The chat server connection is not in a valid state to send the command.
The PersistentChatEndpoint encountered an error communicating with the chat server.
Remarks
This request will be processed asynchronously. See EndQueryChatHistory(IAsyncResult) to complete this asynchronous operation.
Applies to
BeginQueryChatHistory(ICollection<Uri>, String, Boolean, Boolean, AsyncCallback, Object)
Query the chat history for the specified collection of chat rooms, using the designated search string and match options.
public:
IAsyncResult ^ BeginQueryChatHistory(System::Collections::Generic::ICollection<Uri ^> ^ chatRooms, System::String ^ searchString, bool exactPhrase, bool caseSensitive, AsyncCallback ^ userCallback, System::Object ^ state);public IAsyncResult BeginQueryChatHistory (System.Collections.Generic.ICollection<Uri> chatRooms, string searchString, bool exactPhrase, bool caseSensitive, AsyncCallback userCallback, object state);member this.BeginQueryChatHistory : System.Collections.Generic.ICollection<Uri> * string * bool * bool * AsyncCallback * obj -> IAsyncResultPublic Function BeginQueryChatHistory (chatRooms As ICollection(Of Uri), searchString As String, exactPhrase As Boolean, caseSensitive As Boolean, userCallback As AsyncCallback, state As Object) As IAsyncResultParameters
- chatRooms
- ICollection<Uri>
The chat rooms to query.
- searchString
- String
The search string.
- exactPhrase
- Boolean
if set to true the search string is treated as an exact phrase; Otherwise, the search string is treated as a collection of words to match, and any single word match yields a message in the results.
- caseSensitive
- Boolean
if set to true treat the search as case sensitive.
- userCallback
- AsyncCallback
The method to be invoked when this asynchronous operation completes.
- state
- Object
An object to be passed back to the callback.
Returns
An IAsyncResult that references this operation.
Exceptions
chatRooms collection is null or empty.
The PersistentChatEndpoint is not established.
The chat server connection is not in a valid state to send the command.
The PersistentChatEndpoint encountered an error communicating with the chat server.
Remarks
This request will be processed asynchronously. See EndQueryChatHistory(IAsyncResult) to complete this asynchronous operation.
Applies to
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for