Edit

Share via

MultiplayerSessionStates Class

  • Reference

Definition

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

Represents high-level information about the state of a 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 MultiplayerSessionStates
type MultiplayerSessionStates = class
    interface __IMultiplayerSessionStatesPublicNonVirtuals
Public NotInheritable Class MultiplayerSessionStates
Inheritance
Object
MultiplayerSessionStates
Attributes
Windows.Foundation.Metadata.MarshalingBehaviorAttribute Windows.Foundation.Metadata.ThreadingAttribute Windows.Foundation.Metadata.VersionAttribute

Examples

The following example shows the format of the JSON object that represents this class:

"results": [
{
    "xuid": "9876",
    "startTime": "2013-02-01T00:00:00Z",
    "sessionRef": {
        "scid": "foo",
        "templateName": "bar",
        "name": "session-seven"
    },
    "accepted": 4,
    "status": "Active",
    "visibility": "Open",
    "joinRestriction": "Local",
    "myTurn": true,
    "keywords": [
        "one",
        "two"
    ]
}
]

Properties

AcceptedMemberCount

Approximate number of non-reserved members that have been accepted into the session.
IsMyTurn

Indicates if it is the session member's turn.
JoinRestriction

The restriction applied to the member when joining the session.
Keywords

(Optional) A collection of case-insensitive keywords associated with the session. This value might be empty.
SessionReference

A reference to the object that contains identifying information for the session.
StartTime

The data and time that the session began.
Status

The current status of the session.
Visibility

The visibility state of the session. Whether other users can see, or join, etc.
XboxUserId

The Xbox User ID of the member.

Applies to