ContextualSearchService.GetGameClipsAsync 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
| GetGameClipsAsync(UInt32, UInt32, UInt32, String, Boolean, String) |
Get information to hydrate a UI that allows end users to filter or sort game clips |
| GetGameClipsAsync(UInt32, UInt32, UInt32, String, Boolean, String, ContextualSearchFilterOperator, String) |
Get information to hydrate a UI that allows end users to filter or sort game clips |
GetGameClipsAsync(UInt32, UInt32, UInt32, String, Boolean, String)
Get information to hydrate a UI that allows end users to filter or sort game clips
[Windows.Foundation.Metadata.Overload("GetGameClipsAsync1")]
public Windows.Foundation.IAsyncOperation<Microsoft.Xbox.Services.ContextualSearch.ContextualSearchGameClipsResult> GetGameClipsAsync (uint titleId, uint skipItems, uint maxItems, string orderByStatName, bool orderAscending, string searchQuery);abstract member GetGameClipsAsync : uint32 * uint32 * uint32 * string * bool * string -> Windows.Foundation.IAsyncOperation<Microsoft.Xbox.Services.ContextualSearch.ContextualSearchGameClipsResult>
override this.GetGameClipsAsync : uint32 * uint32 * uint32 * string * bool * string -> Windows.Foundation.IAsyncOperation<Microsoft.Xbox.Services.ContextualSearch.ContextualSearchGameClipsResult>Public Function GetGameClipsAsync (titleId As UInteger, skipItems As UInteger, maxItems As UInteger, orderByStatName As String, orderAscending As Boolean, searchQuery As String) As IAsyncOperation(Of ContextualSearchGameClipsResult)Parameters
- titleId
- UInt32
The title ID.
- skipItems
- UInt32
The number of game clips to skip.
- maxItems
- UInt32
The maximum number of game clips the result can contain. Pass 0 to attempt to retrieve the top 100 items.
- orderByStatName
- String
This specifies a stat to sort the game clips by. Pass empty string to default to ordering by viewers descending
- orderAscending
- Boolean
Pass true to order ascending, false to order descending
- searchQuery
- String
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. You can also use grouping operator '()'. The stat properties that can be used to search with are "value", "min", "max", and "delta".
Example 1: To search for game clips during which the "gametype" stat had a value of 1 use "stats:gametype.value eq 1"
Example 2: To search for game clips during which the "rank" stat jumped more than 2. "stats:rank.value gt 2"
Example 3: To search for game clips during which the "rank" stat jumped more than 2 and the "gametype" stat had a value of 1 use "stats:rank.value gt 2 and stat:gametype.value eq 1"
Note:
- The "value" property is only available for string stats and integer stats that are used with a Set.
- The "min", "max" and "delta" properties are only available for double stats and integer stats that are not used with a Set.
Returns
The result is an object which contains information about game clips.
Implements
- Attributes
-
Windows.Foundation.Metadata.OverloadAttribute
Remarks
Calls V1 GET /titles/{titleId}/gameclips
Applies to
GetGameClipsAsync(UInt32, UInt32, UInt32, String, Boolean, String, ContextualSearchFilterOperator, String)
Get information to hydrate a UI that allows end users to filter or sort game clips
[Windows.Foundation.Metadata.Overload("GetGameClipsAsync2")]
public Windows.Foundation.IAsyncOperation<Microsoft.Xbox.Services.ContextualSearch.ContextualSearchGameClipsResult> GetGameClipsAsync (uint titleId, uint skipItems, uint maxItems, string orderByStatName, bool orderAscending, string filterStatName, Microsoft.Xbox.Services.ContextualSearch.ContextualSearchFilterOperator filterOperator, string filterStatValue);abstract member GetGameClipsAsync : uint32 * uint32 * uint32 * string * bool * string * Microsoft.Xbox.Services.ContextualSearch.ContextualSearchFilterOperator * string -> Windows.Foundation.IAsyncOperation<Microsoft.Xbox.Services.ContextualSearch.ContextualSearchGameClipsResult>
override this.GetGameClipsAsync : uint32 * uint32 * uint32 * string * bool * string * Microsoft.Xbox.Services.ContextualSearch.ContextualSearchFilterOperator * string -> Windows.Foundation.IAsyncOperation<Microsoft.Xbox.Services.ContextualSearch.ContextualSearchGameClipsResult>Public Function GetGameClipsAsync (titleId As UInteger, skipItems As UInteger, maxItems As UInteger, orderByStatName As String, orderAscending As Boolean, filterStatName As String, filterOperator As ContextualSearchFilterOperator, filterStatValue As String) As IAsyncOperation(Of ContextualSearchGameClipsResult)Parameters
- titleId
- UInt32
The title ID.
- skipItems
- UInt32
The number of game clips to skip.
- maxItems
- UInt32
The maximum number of game clips the result can contain. Pass 0 to attempt to retrieve the top 100 items.
- orderByStatName
- String
This specifies a stat to sort the game clips by. Pass empty string to default to ordering by viewers descending
- orderAscending
- Boolean
Pass true to order ascending, false to order descending
- filterStatName
- String
This specifies the stat to filter on. Pass empty string for no filter. For example, "gametype.value". The "value" property is only available for string stats and integer stats. The "min", "max" and "delta" properties are only available for double stats and integer stats.
- filterOperator
- ContextualSearchFilterOperator
This specifies operator to apply for the filter.
- filterStatValue
- String
This specifies the value to filter on. The stat properties that can be used to search with are 'value', 'min', 'max', and 'delta'. Pass empty string for no filter
Returns
The result is an object which contains information about game clips.
Implements
- Attributes
-
Windows.Foundation.Metadata.OverloadAttribute
Remarks
Calls V1 GET /titles/{titleId}/gameclips