Logo Xantham

SessionConstructors Type

Ways to get a session. The snapshot and project always come from a response that already pairs them, so the overloads below take those responses rather than leaving a caller to unpack the pair and risk crossing a snapshot with another snapshot's project.

Static members

Static member Description

SessionConstructors.Session(this, snapshot)

Full Usage: SessionConstructors.Session(this, snapshot)

Parameters:
Returns: Session<TscMailbox>

A session on a snapshot's only project. Raises when the snapshot holds none or several, so a caller opening one project never has to index into the array.

this : TscMailbox
snapshot : UpdateSnapshotResponse
Returns: Session<TscMailbox>

SessionConstructors.Session(this, snapshot, project)

Full Usage: SessionConstructors.Session(this, snapshot, project)

Parameters:
Returns: Session<TscMailbox>

A session on one project of a snapshot, named by id. A snapshot can hold several, so the project is not inferred.

this : TscMailbox
snapshot : UpdateSnapshotResponse
project : string
Returns: Session<TscMailbox>

SessionConstructors.Session(this, program)

Full Usage: SessionConstructors.Session(this, program)

Parameters:
Returns: Session<TscMailbox>

A session on what `createProgram` handed back. Raises when the response carries no project, which is the compiler saying the root files resolved to no program at all.

this : TscMailbox
program : CreateProgramResponse
Returns: Session<TscMailbox>

SessionConstructors.Session(this, snapshot, project)

Full Usage: SessionConstructors.Session(this, snapshot, project)

Parameters:
    this : TscMailbox
    snapshot : int
    project : string

Returns: Session<TscMailbox>

A session on `mailbox` over a snapshot and project named directly.

this : TscMailbox
snapshot : int
project : string
Returns: Session<TscMailbox>

SessionConstructors.Session(this, snapshot)

Full Usage: SessionConstructors.Session(this, snapshot)

Parameters:
Returns: Session<TscChannel>

A session on a snapshot's only project. Raises when the snapshot holds none or several, so a caller opening one project never has to index into the array.

this : TscChannel
snapshot : UpdateSnapshotResponse
Returns: Session<TscChannel>

SessionConstructors.Session(this, snapshot, project)

Full Usage: SessionConstructors.Session(this, snapshot, project)

Parameters:
Returns: Session<TscChannel>

A session on one project of a snapshot, named by id. A snapshot can hold several, so the project is not inferred.

this : TscChannel
snapshot : UpdateSnapshotResponse
project : string
Returns: Session<TscChannel>

SessionConstructors.Session(this, program)

Full Usage: SessionConstructors.Session(this, program)

Parameters:
Returns: Session<TscChannel>

A session on what `createProgram` handed back. Raises when the response carries no project, which is the compiler saying the root files resolved to no program at all.

this : TscChannel
program : CreateProgramResponse
Returns: Session<TscChannel>

SessionConstructors.Session(this, snapshot, project)

Full Usage: SessionConstructors.Session(this, snapshot, project)

Parameters:
    this : TscChannel
    snapshot : int
    project : string

Returns: Session<TscChannel>

A session on `channel` over a snapshot and project named directly.

this : TscChannel
snapshot : int
project : string
Returns: Session<TscChannel>

Type something to start searching.