Class SessionJoinRequest

Request to join a session.

Index

Constructors

Properties

_authToken _buildHash _customData _projectId _sessionId

Accessors

authToken buildHash customData projectId sessionId

Methods

assign clone isEqual isEqual

Constructors

constructor

new SessionJoinRequest(
    projectId?: string,
    sessionId?: string,
    buildHash?: string,
    authToken?: string,
    customData?: Iterable<number>,
): SessionJoinRequest
Parameters
- OptionalprojectId: string
- OptionalsessionId: string
- OptionalbuildHash: string
- OptionalauthToken: string
- OptionalcustomData: Iterable<number>
Returns SessionJoinRequest

Properties

`Protected`_authToken

_authToken: string

`Protected`_buildHash

_buildHash: string

`Protected`_customData

_customData: number[]

`Protected`_projectId

_projectId: string

`Protected`_sessionId

_sessionId: string

Accessors

authToken

get authToken(): string

Optional authentication token.

Returns string
set authToken(value: string): void
Parameters
- value: string
Returns void

buildHash

get buildHash(): string

Build hash for version compatibility.

Returns string
set buildHash(value: string): void
Parameters
- value: string
Returns void

customData

get customData(): Iterable<number>

Optional custom data for connection approval.

Returns Iterable<number>
set customData(value: number[] | Iterable<number>): void
Parameters
- value: number[] | Iterable<number>
Returns void

projectId

get projectId(): string

Project identifier used by RSX Server.

Returns string
set projectId(value: string): void
Parameters
- value: string
Returns void

sessionId

get sessionId(): string

Session identifier to join.

Returns string
set sessionId(value: string): void
Parameters
- value: string
Returns void

Methods

assign

assign(other: Immutable<SessionJoinRequest>): SessionJoinRequest
Copies all properties defined by the prototype of SessionJoinRequest from other to this instance.
Parameters
- other: Immutable<SessionJoinRequest>
Returns SessionJoinRequest

clone

clone(): SessionJoinRequest

Clones this instance and returns a new SessionJoinRequest with identical values.

Returns SessionJoinRequest

isEqual

isEqual(
this: Immutable<SessionJoinRequest>,
other: Immutable<SessionJoinRequest>,
): boolean
Determines if this SessionJoinRequest instance is equal to the other instance.
Parameters
- this: Immutable<SessionJoinRequest>
- other: Immutable<SessionJoinRequest>
Returns boolean

`Static`isEqual

isEqual(
lhs: Immutable<SessionJoinRequest>,
rhs: Immutable<SessionJoinRequest>,
): boolean
Determines if both SessionJoinRequest instances are equal.
Parameters
- lhs: Immutable<SessionJoinRequest>
- rhs: Immutable<SessionJoinRequest>
Returns boolean