ChatRoomSession.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(ChatHistoryQueryOptions, AsyncCallback, Object) |
Queries the chat history of this chat room. |
BeginQueryChatHistory(String, Boolean, Boolean, AsyncCallback, Object) |
Query the chat history of this chat room. |
BeginQueryChatHistory(ChatHistoryQueryOptions, AsyncCallback, Object)
Queries the chat history of this chat room.
public:
IAsyncResult ^ BeginQueryChatHistory(Microsoft::Rtc::Collaboration::PersistentChat::ChatHistoryQueryOptions ^ query, AsyncCallback ^ userCallback, System::Object ^ state);
public IAsyncResult BeginQueryChatHistory (Microsoft.Rtc.Collaboration.PersistentChat.ChatHistoryQueryOptions query, AsyncCallback userCallback, object state);
member this.BeginQueryChatHistory : Microsoft.Rtc.Collaboration.PersistentChat.ChatHistoryQueryOptions * AsyncCallback * obj -> IAsyncResult
Public Function BeginQueryChatHistory (query As ChatHistoryQueryOptions, userCallback As AsyncCallback, state As Object) As IAsyncResult
Parameters
- query
- ChatHistoryQueryOptions
The query.
- userCallback
- AsyncCallback
The callback method to be invoked when this asynchronous operation completes.
- state
- Object
An object to be passed back to the callback.
Returns
An IAsyncResult object that references this operation.
Exceptions
query
is null.
The PersistentChatEndpoint is not established.
The State 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 persistent chat server.
Remarks
This request will be processed asynchronously. Call EndQueryChatHistory(IAsyncResult) to complete this asynchronous operation.
Applies to
BeginQueryChatHistory(String, Boolean, Boolean, AsyncCallback, Object)
Query the chat history of this chat room.
public:
IAsyncResult ^ BeginQueryChatHistory(System::String ^ searchString, bool exactPhrase, bool caseSensitive, AsyncCallback ^ userCallback, System::Object ^ state);
public IAsyncResult BeginQueryChatHistory (string searchString, bool exactPhrase, bool caseSensitive, AsyncCallback userCallback, object state);
member this.BeginQueryChatHistory : string * bool * bool * AsyncCallback * obj -> IAsyncResult
Public Function BeginQueryChatHistory (searchString As String, exactPhrase As Boolean, caseSensitive As Boolean, userCallback As AsyncCallback, state As Object) As IAsyncResult
Parameters
- searchString
- String
The search string.
- exactPhrase
- Boolean
if this is 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 this is set to true, treat the search as case sensitive.
- userCallback
- AsyncCallback
The callback method to be invoked when this asynchronous operation completes.
- state
- Object
An object to be passed back to the callback.
Returns
An IAsyncResult object that references this operation.
Exceptions
searchString
is null.
The PersistentChatEndpoint is not established.
The State 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 persistent chat server.
Remarks
This request will be processed asynchronously. Call EndQueryChatHistory(IAsyncResult) to complete this asynchronous operation.
Applies to
Feedback
https://aka.ms/ContentUserFeedback.
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:Submit and view feedback for