Edit

Share via


MultiplayerSession.ServersJson Property

Definition

A JSON string containing a collection of servers for this multiplayer session.

public string ServersJson { get; set; }
member this.ServersJson : string with get, set
Public Property ServersJson As String

Property Value

Implements

Microsoft.Xbox.Services.Multiplayer.__IMultiplayerSessionPublicNonVirtuals.ServersJson

Remarks

The most common server involved in the session is used when the session is submitted to matchmaking using the MatchmakingService.CreateMatchTicketAsync Method. Once the title has made this call, the JSON object for ServersJson has one server object child, named "matchmaking". The server object contains information about the matchmaking for the session.

After setting ServersJson, the title must call MultiplayerService.WriteSessionAsync to write batched local changes to the service. If the method is called without calling WriteSessionAsync, the method only changes the local session object but does not commit it to the server.

Applies to