Class Terminal

Index

Constructors

Accessors

Methods

createTicket getConnectionInfo open

Constructors

constructor

new Terminal(vmid: string | number, client: Client): Terminal
Parameters
- vmid: string | number
- client: Client
Returns Terminal
- Defined in src/helpers/Terminal.ts:241

Accessors

ticket

get ticket(): TerminalTicket | undefined
Returns TerminalTicket | undefined
- Defined in src/helpers/Terminal.ts:247

Methods

createTicket

createTicket(): Promise<TerminalTicket>
Returns Promise<TerminalTicket>
- Defined in src/helpers/Terminal.ts:251

getConnectionInfo

getConnectionInfo(): Promise<TerminalConnectionInfo>
Returns Promise<TerminalConnectionInfo>
- Defined in src/helpers/Terminal.ts:272

open

open(options?: TerminalOpenOptions): Promise<TerminalSession>
Parameters
- options: TerminalOpenOptions = {}
Returns Promise<TerminalSession>
- Defined in src/helpers/Terminal.ts:293