Shells

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	An event triggered when a user types any sort of input into a terminal
ShellRequest.Resize	An event triggered when a user resizes a terminal
ShellResponse	No description
ShellResponse.Acknowledged	Emitted by the provider to acknowledge a previous request
ShellResponse.Data	Emitted by the provider when new data is available for the terminal
ShellResponse.Initialized	Emitted by the provider when the terminal has been initialized

Remote Procedure Calls

open

Request	Response	Error
ShellRequest	ShellResponse	CommonErrorMessage

Data Models

ShellRequest

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

---

ShellRequest.Initialize

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

---

ShellRequest.Input

An event triggered when a user types any sort of input into a terminal

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

Properties

data: String

type: String /* "input" */ The type discriminator

---

ShellRequest.Resize

An event triggered when a user resizes a terminal

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

Properties

cols: Int

rows: Int

type: String /* "resize" */ The type discriminator

---

ShellResponse

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

---

ShellResponse.Acknowledged

Emitted by the provider to acknowledge a previous request

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

Properties

type: String /* "ack" */ The type discriminator

---

ShellResponse.Data

Emitted by the provider when new data is available for the terminal

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

Properties

data: String

type: String /* "data" */ The type discriminator

---

ShellResponse.Initialized

Emitted by the provider when the terminal has been initialized

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

Properties

type: String /* "initialize" */ The type discriminator

---