Shells

API: Experimental/Alpha

Table of Contents

1. Remote Procedure Calls
Name Description
open No description
2. Data Models
Name Description
ShellRequest No description
ShellRequest.Initialize No description
ShellRequest.Input No description
ShellRequest.Resize No description
ShellResponse No description
ShellResponse.Acknowledged No description
ShellResponse.Data No description
ShellResponse.Initialized No description

Remote Procedure Calls

open

API: Experimental/Alpha Auth: Public

Request Response Error
ShellRequest ShellResponse CommonErrorMessage

Data Models

ShellRequest

API: Internal/Beta

sealed class ShellRequest {
    class Initialize : ShellRequest()
    class Input : ShellRequest()
    class Resize : ShellRequest()
}

ShellRequest.Initialize

API: Internal/Beta

data class Initialize(
    val sessionIdentifier: String,
    val cols: Int?,
    val rows: Int?,
    val type: String /* "initialize" */,
)
Properties
sessionIdentifier: String
cols: Int?
rows: Int?
type: String /* "initialize" */ The type discriminator

API: Stable


ShellRequest.Input

API: Internal/Beta

data class Input(
    val data: String,
    val type: String /* "input" */,
)
Properties
data: String
type: String /* "input" */ The type discriminator

API: Stable


ShellRequest.Resize

API: Internal/Beta

data class Resize(
    val cols: Int,
    val rows: Int,
    val type: String /* "resize" */,
)
Properties
cols: Int
rows: Int
type: String /* "resize" */ The type discriminator

API: Stable


ShellResponse

API: Internal/Beta

sealed class ShellResponse {
    class Acknowledged : ShellResponse()
    class Data : ShellResponse()
    class Initialized : ShellResponse()
}

ShellResponse.Acknowledged

API: Internal/Beta

data class Acknowledged(
    val type: String /* "ack" */,
)
Properties
type: String /* "ack" */ The type discriminator

API: Stable


ShellResponse.Data

API: Internal/Beta

data class Data(
    val data: String,
    val type: String /* "data" */,
)
Properties
data: String
type: String /* "data" */ The type discriminator

API: Stable


ShellResponse.Initialized

API: Internal/Beta

data class Initialized(
    val type: String /* "initialize" */,
)
Properties
type: String /* "initialize" */ The type discriminator

API: Stable