MultiplayerSessionMember Class

Definition

Namespace:

Microsoft.Xbox.Services.Multiplayer

Assembly:

Microsoft.Xbox.Services.dll

Represents a reference to a member in a multiplayer session.

[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 MultiplayerSessionMember

type MultiplayerSessionMember = class
    interface __IMultiplayerSessionMemberPublicNonVirtuals

Public NotInheritable Class MultiplayerSessionMember

Inheritance

Object

MultiplayerSessionMember

Attributes

Windows.Foundation.Metadata.MarshalingBehaviorAttribute Windows.Foundation.Metadata.ThreadingAttribute Windows.Foundation.Metadata.VersionAttribute

Properties

ActiveTitleId	The identifier of the title for the game being played in the session, if the member is active.
ArbitrationStatus	The current status/state of the results.
DeviceToken	The case-insensitive device token string for the multiplayer session member, which can be used for equality comparisons. The token is set when the member uploads a secure device address.
Encounters	Gets a list of group names for the current user indicating which groups that user encountered during a multiplayer session.
Gamertag	(Optional) The Gamertag of the member. This value is only known if the member has accepted.
Groups	Gets or sets a string vector of group names for the current user indicating which groups that user was part of during a multiplayer session.
InitializationEpisode	The number of the initialization episode that the member participates in during managed initialization. This value is only useful to read when the title is manually managing its own QoS.
InitializationFailureCause	The cause of why the initialization failed for the member. If there is no failure, this value is MultiplayerMeasurementFailure::None. Set when transitioning out of the "joining" or "measuring" stage if this member doesn't pass.
InitializeRequested	A value that indicates if a QoS initialization stage has been requested for this user during managed initialization. Ignored if there is not a "memberInitialization" section for the session. Defaults to false.
IsCurrentUser	A value that indicates if this multiplayer session member is the player whose Xbox Live context was used to create or retrieve the current MultiplayerSession object.
IsTurnAvailable	A value that indicates if this member has an available turn in the session.
JoinTime	The time the user joined the session. If "reserved" is true, this is the time when the reservation was made.
MatchmakingResultServerMeasurementsJson	A JSON string id that defines items that provide some matchmaking context around how and why they were matched into the session. This is a copy of the user's QoS serverMeasurements from the matchmaking session.
MemberCustomConstantsJson	A JSON string that specifies the custom player constants for the member.
MemberCustomPropertiesJson	A JSON string that specifies the custom player properties for the member.
MemberId	The Id for this multiplayer session member.
MemberMeasurements	QoS measurements for the member's secure device address.
MemberServerMeasurementsJson	Identifier of a JSON string defining the QoS measurements for the multiplayer session member in a session.
MembersInGroup	A collection of members in any groups to which the session member belongs.
Nat	The device's NAT setting when the member uploads a secure device address.
Results	The arbitration results submitted by the member.
Roles	A collection of role types to role names for this member. (Optional)
SecureDeviceAddressBase64	(Optional) The base64 encoded secure device address of the member.
Status	The status of this member.
TeamId	The Id of this members' team in a tournament.
TournamentTeamSessionRef	The tournament team session reference.
XboxUserId	The Xbox User ID of the member. This value is only known if the member has accepted.