MultiplayerService.GetSearchHandlesAsync 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
| GetSearchHandlesAsync(MultiplayerQuerySearchHandleRequest) |
Queries for the all search handles that references the searchable sessions given the specific query. There is no paging or continuation, and the multiplayer service will limit the number of items returned to 100. |
| GetSearchHandlesAsync(String, String, String, Boolean, String) |
Queries for the all search handles that references the searchable sessions given the specific query. There is no paging or continuation, and the multiplayer service will limit the number of items returned to 100. Call GetSearchHandlesAsync(MultiplayerQuerySearchHandleRequest^ ) instead. |
GetSearchHandlesAsync(MultiplayerQuerySearchHandleRequest)
Queries for the all search handles that references the searchable sessions given the specific query. There is no paging or continuation, and the multiplayer service will limit the number of items returned to 100.
[Windows.Foundation.Metadata.Overload("GetSearchHandlesAsync1")]
public Windows.Foundation.IAsyncOperation<Windows.Foundation.Collections.IVectorView<Microsoft.Xbox.Services.Multiplayer.MultiplayerSearchHandleDetails>> GetSearchHandlesAsync (Microsoft.Xbox.Services.Multiplayer.MultiplayerQuerySearchHandleRequest searchHandleRequest);abstract member GetSearchHandlesAsync : Microsoft.Xbox.Services.Multiplayer.MultiplayerQuerySearchHandleRequest -> Windows.Foundation.IAsyncOperation<Windows.Foundation.Collections.IVectorView<Microsoft.Xbox.Services.Multiplayer.MultiplayerSearchHandleDetails>>
override this.GetSearchHandlesAsync : Microsoft.Xbox.Services.Multiplayer.MultiplayerQuerySearchHandleRequest -> Windows.Foundation.IAsyncOperation<Windows.Foundation.Collections.IVectorView<Microsoft.Xbox.Services.Multiplayer.MultiplayerSearchHandleDetails>>Public Function GetSearchHandlesAsync (searchHandleRequest As MultiplayerQuerySearchHandleRequest) As IAsyncOperation(Of IVectorView(Of MultiplayerSearchHandleDetails))Parameters
- searchHandleRequest
- MultiplayerQuerySearchHandleRequest
A search handle request object that queries for the all search handles.
Returns
The async object for notifying when the operation is completed. This contains a vectorview of MultiplayerSearchHandleDetails objects, containing the details of the search handles.
Implements
- Attributes
-
Windows.Foundation.Metadata.OverloadAttribute
Applies to
GetSearchHandlesAsync(String, String, String, Boolean, String)
Queries for the all search handles that references the searchable sessions given the specific query. There is no paging or continuation, and the multiplayer service will limit the number of items returned to 100. Call GetSearchHandlesAsync(MultiplayerQuerySearchHandleRequest^ ) instead.
[Windows.Foundation.Metadata.Overload("GetSearchHandlesAsync2")]
public Windows.Foundation.IAsyncOperation<Windows.Foundation.Collections.IVectorView<Microsoft.Xbox.Services.Multiplayer.MultiplayerSearchHandleDetails>> GetSearchHandlesAsync (string serviceConfigurationId, string sessionTemplateName, string orderBy, bool orderAscending, string searchFilter);abstract member GetSearchHandlesAsync : string * string * string * bool * string -> Windows.Foundation.IAsyncOperation<Windows.Foundation.Collections.IVectorView<Microsoft.Xbox.Services.Multiplayer.MultiplayerSearchHandleDetails>>
override this.GetSearchHandlesAsync : string * string * string * bool * string -> Windows.Foundation.IAsyncOperation<Windows.Foundation.Collections.IVectorView<Microsoft.Xbox.Services.Multiplayer.MultiplayerSearchHandleDetails>>Public Function GetSearchHandlesAsync (serviceConfigurationId As String, sessionTemplateName As String, orderBy As String, orderAscending As Boolean, searchFilter As String) As IAsyncOperation(Of IVectorView(Of MultiplayerSearchHandleDetails))Parameters
- serviceConfigurationId
- String
The scid within which to query for search handles.
- sessionTemplateName
- String
The name of the template to query for search handles.
- orderBy
- String
This specifies the attribute to sort the search handles by. Pass empty string to default to ordering by 'Timestamp asc'
- orderAscending
- Boolean
Pass true to order ascending, false to order descending
- searchFilter
- String
The query string to get the search handles for. The search query. The query syntax is an OData like syntax with only the following operators supported EQ, NE, GE, GT, LE and LT along with the logical operators of AND and OR.
Example 1: To search for search handles for a specific XboxUserId use "MemberXuids/any(d:d eq '12345678')" or "OwnerXuids/any(d:d eq '12345678')"
Example 2: To search for search handles for a title defined string metadata use "Strings/stringMetadataType eq 'value'"
Example 3: To search for search handles for a title defined numbers metadata AND a tag type value use "Numbers/numberMetadataType eq 53 AND Tags/tagType eq 'value'"
Returns
The async object for notifying when the operation is completed. This contains a vectorview of MultiplayerSearchHandleDetails objects, containing the details of the search handles.
Implements
- Attributes
-
Windows.Foundation.Metadata.OverloadAttribute