Class Session

• Defined in File Session.cs

Inheritance Relationships

Base Type

• public xbe.sdk.EntityBase (Class EntityBase)

Class Documentation

class xbe.sdk.Models.Session : xbe.sdk.EntityBase

A session is describes a real-time interaction between a group of one or more players.

REQUIRES: Session Services

Public Functions

Session ()

Session (Object obj)

Properties

Object Data { get; set; }

The map of arbitrary data associated with the session.

Guid HostUid { get; set; }

The UUID of the host user that owns the session. If no host is specified then the session is considered to be owned by the system itself. When a session has no host any member may modify the session data. If a host is specified then only that user may modify the session data.

Guid > Invited { get; set; }

The list of UUIDs for each user that has been invited to the session by the host.

int NumTeams { get; set; }

The total number of teams represented in the match.

string Password { get; set; }

The secret password that must be given in order to join the session.

Guid ProductUid { get; set; }

The uid of the product that this session is associated with.

REQUIRES: Session Services Studio.

string ServerUrl { get; set; }

The connection URL of the session server associated with the session.

string Status { get; set; }

The current activity state of the session.

Team > Teams { get; set; }

The list of teams, containing player assignments, for the match.

int TeamSize { get; set; }

The maximum number of players allowed per team.

string Type { get; set; }

The type of session.

Guid > Users { get; set; }

The list of UUIDs for each user involved in the match.

string Visibility { get; set; }

The visibility of the session within the global roster.

Public Static Functions

new Session Parse (string json)

Parses the given JSON encoded string into a new Session instance.

Param json:

Return:

Public Static Attributes

const string TYPE_GAME = "GAME"

const string TYPE_LOBBY = "LOBBY"

const string TYPE_PARTY = "PARTY"

const string STATUS_WAITING_FOR_PLAYERS = "WAITING_FOR_PLAYERS"

const string STATUS_IDLE = "IDLE"

const string STATUS_IN_PROGRESS = "IN_PROGRESS"

const string STATUS_ENDED = "ENDED"

const string VISIBILITY_PUBLIC = "PUBLIC"

const string VISIBILITY_FRIENDS_EXTENDED = "FRIENDS_EXTENDED"

const string VISIBILITY_FRIENDS_ONLY = "FRIENDS_ONLY"

const string VISIBILITY_INVITE_ONLY = "INVITE_ONLY"

const string VISIBILITY_LOCKED = "LOCKED"