Class Session

Readonlyconnection

offline

• get offline(): boolean

  Get offline status.

  Returns boolean

• set offline(value: boolean): void

  Set offline status.

  Parameters

  • value: boolean

  Returns void

directory_change

• directory_change(path: string): Promise<void>

  Changes directory as an interactive cd operation while retaining the previous directory for cd -.

  Other temporary context changes use setCWD directly and therefore do not disturb interactive navigation history.

  Parameters

  • path: string

    New current working directory.

  Returns Promise<void>

  Nothing.

getCWD

• getCWD(): Promise<string>

  The current working directory: what the backend stores for the identity, or, before it has stored anything, the identity's home.

  A first session used to begin at /, which is a place nobody works in — the operator's own words: "she should be in the user's homedir". A shell lands in the home; so does this one. A stored directory is always honoured, / included, since the operator put it there.

  Returns Promise<string>

init

• init(): Promise<void>

  Initialize the session: the backend prepares its own state.

  Returns Promise<void>

physicalMode_get

• physicalMode_get(): boolean

  Gets physical filesystem mode status.

  When true, path operations work directly with physical paths without logical-to-physical mapping.

  Returns boolean

  True if in physical mode, false if using logical paths.

physicalMode_set

• physicalMode_set(enabled: boolean): void

  Sets physical filesystem mode.

  Parameters

  • enabled: boolean

    True to enable physical mode, false for logical mode.

  Returns void

previousCWD_get

• previousCWD_get(): string | undefined

  Returns the directory immediately preceding the latest interactive change.

  Returns string | undefined

  Previous directory, or undefined when none exists in this session.

regard_get

• regard_get(): | {
      address: string;
      groupId: string;
      modelKind?: string;
      paneId: string;
  }
  | null

  Returns the session's retained regard: the addressable thing the operator most recently indicated on any surface, or null before the first indication. Last write wins; the value survives surface reattachment for the life of the session.

  Returns { address: string; groupId: string; modelKind?: string; paneId: string } | null

  The retained regard, or null when nothing has been indicated.

regard_set

• regard_set(
      regard: {
          address: string;
          groupId: string;
          modelKind?: string;
          paneId: string;
      },
  ): void

  Retains a regard write from a surface.

  Parameters

  • regard: { address: string; groupId: string; modelKind?: string; paneId: string }

    The indicated address with its provenance.

  Returns void

setCWD

• setCWD(path: string): Promise<void>

  Set Current Working Directory: the backend stores it for the identity.

  Parameters

  • path: string

  Returns Promise<void>

timingEnabled_get

• timingEnabled_get(): boolean

  Gets timing mode status.

  When true, command execution times are displayed after each command.

  Returns boolean

  True if timing is enabled, false otherwise.

timingEnabled_set

• timingEnabled_set(enabled: boolean): void

  Sets timing mode.

  Parameters

  • enabled: boolean

    True to enable timing display, false to disable.

  Returns void

StaticgetInstance

• getInstance(): Session

  Returns the singleton instance of the Session.

  Returns Session