Table of Contents

Class Session

Class represents a single Session attribute

public class Session
Inheritance
Session
Inherited Members

Fields

ActiveSession

public ActiveSession ActiveSession

Field Value

ActiveSession

AllowJoinInProgress

public bool AllowJoinInProgress

Field Value

bool

Attributes

public List<SessionAttribute> Attributes

Field Value

List<SessionAttribute>

BucketId

public string BucketId

Field Value

string

Id

public string Id

Field Value

string

InvitesAllowed

public bool InvitesAllowed

Field Value

bool

MaxPlayers

public uint MaxPlayers

Field Value

uint

Name

public string Name

Field Value

string

NumConnections

public uint NumConnections

Field Value

uint

PermissionLevel

public OnlineSessionPermissionLevel PermissionLevel

Field Value

OnlineSessionPermissionLevel

SanctionsEnabled

public bool SanctionsEnabled

Field Value

bool

SearchResults

public bool SearchResults

Field Value

bool

SessionState

public OnlineSessionState SessionState

Field Value

OnlineSessionState

UpdateInProgress

public bool UpdateInProgress

Field Value

bool

Methods

DoesLocalUserOwnSession()

Determines if the local user owns this Session. This information can be used to gate some Session modifying actions.

public bool DoesLocalUserOwnSession()

Returns

bool

True if the Session is owned by the local user. False if either it was determined that the user doesn't own this Session, or if the operation to query that information failed.

Equals(object)

Determines whether the specified object is equal to the current object.

public override bool Equals(object other)

Parameters

other object

Returns

bool

true if the specified object is equal to the current object; otherwise, false.

GetHashCode()

Serves as the default hash function.

public override int GetHashCode()

Returns

int

A hash code for the current object.

InitActiveSession()

public void InitActiveSession()

InitFromInfoOfSessionDetails(SessionDetails)

public bool InitFromInfoOfSessionDetails(SessionDetails session)

Parameters

session SessionDetails

Returns

bool

InitFromSessionInfo(SessionDetails, SessionDetailsInfo?)

public void InitFromSessionInfo(SessionDetails Session, SessionDetailsInfo? sessionDetailsInfo)

Parameters

Session SessionDetails
sessionDetailsInfo SessionDetailsInfo?

IsValid()

public bool IsValid()

Returns

bool

TryGetRegisteredUsers(out List<ProductUserId>)

public bool TryGetRegisteredUsers(out List<ProductUserId> userIds)

Parameters

userIds List<ProductUserId>

Returns

bool