PersistentChatServices.BeginBrowseChatRoomsByFilterCriteria 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.
Browse a list of chat rooms based on a set of filter criteria
public:
IAsyncResult ^ BeginBrowseChatRoomsByFilterCriteria(System::String ^ searchTerms, bool searchDesc, System::String ^ member, System::String ^ manager, Uri ^ categoryUri, Nullable<Guid> addinGuid, bool disabled, Nullable<Microsoft::Rtc::Collaboration::PersistentChat::ChatRoomPrivacy> privacy, Nullable<Microsoft::Rtc::Collaboration::PersistentChat::ChatRoomBehavior> behavior, Nullable<bool> invitations, bool searchInvitiations, int maxResults, AsyncCallback ^ userCallback, System::Object ^ state);
public IAsyncResult BeginBrowseChatRoomsByFilterCriteria (string searchTerms, bool searchDesc, string member, string manager, Uri categoryUri, Nullable<Guid> addinGuid, bool disabled, Nullable<Microsoft.Rtc.Collaboration.PersistentChat.ChatRoomPrivacy> privacy, Nullable<Microsoft.Rtc.Collaboration.PersistentChat.ChatRoomBehavior> behavior, Nullable<bool> invitations, bool searchInvitiations, int maxResults, AsyncCallback userCallback, object state);
member this.BeginBrowseChatRoomsByFilterCriteria : string * bool * string * string * Uri * Nullable<Guid> * bool * Nullable<Microsoft.Rtc.Collaboration.PersistentChat.ChatRoomPrivacy> * Nullable<Microsoft.Rtc.Collaboration.PersistentChat.ChatRoomBehavior> * Nullable<bool> * bool * int * AsyncCallback * obj -> IAsyncResult
Public Function BeginBrowseChatRoomsByFilterCriteria (searchTerms As String, searchDesc As Boolean, member As String, manager As String, categoryUri As Uri, addinGuid As Nullable(Of Guid), disabled As Boolean, privacy As Nullable(Of ChatRoomPrivacy), behavior As Nullable(Of ChatRoomBehavior), invitations As Nullable(Of Boolean), searchInvitiations As Boolean, maxResults As Integer, userCallback As AsyncCallback, state As Object) As IAsyncResult
Parameters
- searchTerms
- String
The terms to search in the name for
- searchDesc
- Boolean
Bool deciding whether to search in the description as well as name
- member
- String
Look for all rooms that have this principal as a member
- manager
- String
Look for all rooms that have this principal as a manager
- categoryUri
- Uri
Search for rooms under this category
- disabled
- Boolean
Search for rooms with this disabled setting
- privacy
- Nullable<ChatRoomPrivacy>
Search for rooms with this privacy setting
- behavior
- Nullable<ChatRoomBehavior>
Search for rooms with this behavior setting
- searchInvitiations
- Boolean
Determines if we search using the invitations settings
- maxResults
- Int32
The max number of results returned
- 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 EndBrowseChatRoomsByFilterCriteria(IAsyncResult) to complete this asynchronous operation. If a parameter is null, then we do not search under that parameter. The only exceptions are searchDesc, which is false to not search description, and invitations, which uses the searchInvitations parameter to determine when to search invitations
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