Edit

Share via

MultiplayerGetSessionsRequest Class

  • Reference

Definition

Namespace:
Microsoft.Xbox.Services.Multiplayer
Assembly:
Microsoft.Xbox.Services.dll

Defines the search filters for retrieveing a collection of discoverable sessions. Used in MultiplayerService::GetSessionsAsync().

[Windows.Foundation.Metadata.Activatable(typeof(Microsoft.Xbox.Services.Multiplayer.__IMultiplayerGetSessionsRequestFactory), 1)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
[Windows.Foundation.Metadata.Version(1)]
public sealed class MultiplayerGetSessionsRequest
type MultiplayerGetSessionsRequest = class
    interface __IMultiplayerGetSessionsRequestPublicNonVirtuals
Public NotInheritable Class MultiplayerGetSessionsRequest
Inheritance
Object
MultiplayerGetSessionsRequest
Attributes
Windows.Foundation.Metadata.ActivatableAttribute Windows.Foundation.Metadata.MarshalingBehaviorAttribute Windows.Foundation.Metadata.ThreadingAttribute Windows.Foundation.Metadata.VersionAttribute

Constructors

MultiplayerGetSessionsRequest(String, UInt32)

Constructs a new MultiplayerGetSessionsRequest object.

Properties

ContractVersionFilter

Filter results to just sessions with this major version, or less, of the contract. Set to 0 to ignore the contract version.
IncludeInactiveSessions

Indicates if inactive sessions are included in the results. You must specify xboxUserIdFilter if this value is set to true.
IncludePrivateSessions

Indicates if private sessions are included in the results.
IncludeReservations

Indicates if sessions that the user hasn't accepted are included in the results. You must specify xboxUserIdFilter if this value is set to true.
KeywordFilter

Optional. Filter results to just sessions with this keyword. You must specify one of XboxUserIdFilter, XboxUserIdsFilter, or KeywordFilter.
MaxItems

The maximum number of sessions to return.
ServiceConfigurationId

The service configuration id that the sessions are part of.
SessionTemplateNameFilter

Optional. The name of the template for the multiplayer session to filter on.
VisibilityFilter

Filter results to just sessions with the specified visibility.
XboxUserIdFilter

Optional. Filter results to just sessions that contain this Xbox User ID. You must specify one of XboxUserIdFilter, XboxUserIdsFilter, or KeywordFilter.
XboxUserIdsFilter

Optional. Filter results to just sessions that contains these Xbox User IDs. You must specify one of XboxUserIdFilter, XboxUserIdsFilter, or KeywordFilter.

Applies to