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
|
Full Usage:
SessionConstructors.Session(this, snapshot)
Parameters:
TscMailbox
snapshot : UpdateSnapshotResponse
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.
|
Full Usage:
SessionConstructors.Session(this, snapshot, project)
Parameters:
TscMailbox
snapshot : UpdateSnapshotResponse
project : string
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.
|
Full Usage:
SessionConstructors.Session(this, program)
Parameters:
TscMailbox
program : CreateProgramResponse
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.
|
Full Usage:
SessionConstructors.Session(this, snapshot, project)
Parameters:
TscMailbox
snapshot : int
project : string
Returns: Session<TscMailbox>
|
A session on `mailbox` over a snapshot and project named directly.
|
Full Usage:
SessionConstructors.Session(this, snapshot)
Parameters:
TscChannel
snapshot : UpdateSnapshotResponse
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.
|
Full Usage:
SessionConstructors.Session(this, snapshot, project)
Parameters:
TscChannel
snapshot : UpdateSnapshotResponse
project : string
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.
|
Full Usage:
SessionConstructors.Session(this, program)
Parameters:
TscChannel
program : CreateProgramResponse
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.
|
Full Usage:
SessionConstructors.Session(this, snapshot, project)
Parameters:
TscChannel
snapshot : int
project : string
Returns: Session<TscChannel>
|
A session on `channel` over a snapshot and project named directly.
|