PersistentChatServices.BeginBrowseChatRoomsByCriteria 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
| BeginBrowseChatRoomsByCriteria(String, Boolean, Boolean, Boolean, AsyncCallback, Object) |
Browse a list of chat rooms based on a specified search criteria. The search will be performed against the chat room names, and optionally the description. |
| BeginBrowseChatRoomsByCriteria(String, Boolean, Boolean, Boolean, Int32, AsyncCallback, Object) |
Browse a list of chat rooms based on a specified search criteria. The search will be performed against the chat room names, and optionally the descriptions. The number of results will be limited to the number specified in the maxResults parameter. |
BeginBrowseChatRoomsByCriteria(String, Boolean, Boolean, Boolean, AsyncCallback, Object)
Browse a list of chat rooms based on a specified search criteria. The search will be performed against the chat room names, and optionally the description.
public:
IAsyncResult ^ BeginBrowseChatRoomsByCriteria(System::String ^ criteria, bool searchDescription, bool matchAll, bool matchExactPhrase, AsyncCallback ^ userCallback, System::Object ^ state);public IAsyncResult BeginBrowseChatRoomsByCriteria (string criteria, bool searchDescription, bool matchAll, bool matchExactPhrase, AsyncCallback userCallback, object state);member this.BeginBrowseChatRoomsByCriteria : string * bool * bool * bool * AsyncCallback * obj -> IAsyncResultPublic Function BeginBrowseChatRoomsByCriteria (criteria As String, searchDescription As Boolean, matchAll As Boolean, matchExactPhrase As Boolean, userCallback As AsyncCallback, state As Object) As IAsyncResultParameters
- criteria
- String
The search criteria.
- searchDescription
- Boolean
if set to true the search will also match against the description of the chat rooms.
- matchAll
- Boolean
if matchExactPhrase is false, the search will return only rooms that match all search strings if this is set to true, otherwise it will return rooms that match one or more of the search strings.
- matchExactPhrase
- Boolean
If true, the search criteria will be treated as a single search string, otherwise it will be considered a whitespace delimited set of search strings.
- 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
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 persistent chat server.
Remarks
This request will be processed asynchronously. See EndBrowseChatRoomsByCriteria(IAsyncResult) to complete this asynchronous operation.
Applies to
BeginBrowseChatRoomsByCriteria(String, Boolean, Boolean, Boolean, Int32, AsyncCallback, Object)
Browse a list of chat rooms based on a specified search criteria. The search will be performed against the chat room names, and optionally the descriptions. The number of results will be limited to the number specified in the maxResults parameter.
public:
IAsyncResult ^ BeginBrowseChatRoomsByCriteria(System::String ^ criteria, bool searchDescription, bool matchAll, bool matchExactPhrase, int maxResults, AsyncCallback ^ userCallback, System::Object ^ state);public IAsyncResult BeginBrowseChatRoomsByCriteria (string criteria, bool searchDescription, bool matchAll, bool matchExactPhrase, int maxResults, AsyncCallback userCallback, object state);member this.BeginBrowseChatRoomsByCriteria : string * bool * bool * bool * int * AsyncCallback * obj -> IAsyncResultPublic Function BeginBrowseChatRoomsByCriteria (criteria As String, searchDescription As Boolean, matchAll As Boolean, matchExactPhrase As Boolean, maxResults As Integer, userCallback As AsyncCallback, state As Object) As IAsyncResultParameters
- criteria
- String
The search criteria.
- searchDescription
- Boolean
if set to true the search will also match against description of the chat rooms.
- matchAll
- Boolean
if matchExactPhrase is false, the search will return only rooms that match all search strings if this this is set to true, otherwise it will return rooms that match one or more of the search strings.
- matchExactPhrase
- Boolean
If true, the search criteria will be treated as a single search string, otherwise it will be considered a whitespace delimited set of search strings.
- maxResults
- Int32
The max number of results to return. To return all matching results set this value to -1.
- 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
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 EndBrowseChatRoomsByCriteria(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