Options
All
  • Public
  • Public/Protected
  • All
Menu

Represents a Command.

Hierarchy

  • Command

Implements

Index

Constructors

constructor

  • Constructs a new Command.

    Parameters

    Returns Command

Properties

Optional VCRLog

VCRLog: undefined | null | IVCRLog

Command VCRLog.

Optional auth

auth: undefined | null | IAuth

Command auth.

Optional body

body: undefined | "openChan" | "openChanRes" | "closeChan" | "closeChanRes" | "containerState" | "portOpen" | "toast" | "runMain" | "clear" | "eval" | "result" | "input" | "output" | "error" | "saneTerm" | "resizeTerm" | "state" | "ok" | "persist" | "write" | "remove" | "move" | "mkdir" | "read" | "readdir" | "files" | "file" | "checkChanges" | "changedFiles" | "lintResults" | "runContainedTest" | "testResult" | "debuggerStart" | "debuggerStep" | "debuggerStatus" | "ensurePackages" | "ping" | "pong" | "hello" | "goodbye" | "hint" | "connect" | "send" | "recv" | "disconnect" | "fileAuthReq" | "fileAuthRes" | "mutliFileAuthRes" | "ot" | "otstatus" | "otLinkFile" | "otNewCursor" | "otDeleteCursor" | "flush" | "debug" | "startVCR" | "readVCR" | "VCRLog" | "auth" | "execInfo" | "subscribe" | "eventCreated" | "eventModified" | "eventDeleted" | "eventMoved" | "subscribeFile" | "fileEvent" | "roster" | "join" | "part" | "exec" | "packageSearch" | "packageSearchResp" | "packageInfo" | "packageInfoResp" | "packageAdd" | "packageRemove" | "packageInstall" | "packageListSpecfile" | "packageListSpecfileResp" | "packageCacheSave" | "chatMessage" | "chatTyping" | "chatScrollback"

Command body.

Optional changedFiles

changedFiles: undefined | null | IFiles

Command changedFiles.

channel

channel: number

Command channel.

Optional chatMessage

chatMessage: undefined | null | IChatMessage

Command chatMessage.

Optional chatScrollback

chatScrollback: undefined | null | IChatScrollback

Command chatScrollback.

Optional chatTyping

chatTyping: undefined | null | IChatTyping

Command chatTyping.

Optional checkChanges

checkChanges: undefined | null | ICheckChanges

Command checkChanges.

Optional clear

clear: undefined | null | IClear

Command clear.

Optional closeChan

closeChan: undefined | null | ICloseChannel

Command closeChan.

Optional closeChanRes

closeChanRes: undefined | null | ICloseChannelRes

Command closeChanRes.

Optional connect

connect: undefined | null | IConnect

Command connect.

Optional containerState

containerState: undefined | null | IContainerState

Command containerState.

Optional debug

debug: undefined | null | IDebug

Command debug.

debuggerStart

debuggerStart: string

Command debuggerStart.

Optional debuggerStatus

debuggerStatus: undefined | null | IDebugStatus

Command debuggerStatus.

Optional debuggerStep

debuggerStep: undefined | null | IRunMain

Command debuggerStep.

Optional disconnect

disconnect: undefined | null | IDisconnect

Command disconnect.

Optional ensurePackages

ensurePackages: undefined | null | IEnsurePackages

Command ensurePackages.

error

error: string

Command error.

eval

eval: string

Command eval.

Optional eventCreated

eventCreated: undefined | null | IFile

Command eventCreated.

Optional eventDeleted

eventDeleted: undefined | null | IFile

Command eventDeleted.

Optional eventModified

eventModified: undefined | null | IFile

Command eventModified.

Optional eventMoved

eventMoved: undefined | null | IMove

Command eventMoved.

Optional exec

exec: undefined | null | IExec

Command exec.

Optional execInfo

execInfo: undefined | null | IExecInfo

Command execInfo.

Optional file

file: undefined | null | IFile

Command file.

Optional fileAuthReq

fileAuthReq: undefined | null | IFileAuthReq

Command fileAuthReq.

Optional fileAuthRes

fileAuthRes: undefined | null | IFileAuthRes

Command fileAuthRes.

Optional fileEvent

fileEvent: undefined | null | IFileEvent

Command fileEvent.

Optional files

files: undefined | null | IFiles

Command files.

Optional flush

flush: undefined | null | IFlush

Command flush.

Optional goodbye

goodbye: undefined | null | IGoodbye

Command goodbye.

Optional hello

hello: undefined | null | IHello

Command hello.

Optional hint

hint: undefined | null | IHint

Command hint.

input

input: string

Command input.

Optional join

join: undefined | null | IUser

Command join.

Optional lintResults

lintResults: undefined | null | ILintResults

Command lintResults.

Optional mkdir

mkdir: undefined | null | IFile

Command mkdir.

Optional move

move: undefined | null | IMove

Command move.

Optional mutliFileAuthRes

mutliFileAuthRes: undefined | null | IMultiFileAuthRes

Command mutliFileAuthRes.

Optional ok

ok: undefined | null | IOK

Command ok.

Optional openChan

openChan: undefined | null | IOpenChannel

Command openChan.

Optional openChanRes

openChanRes: undefined | null | IOpenChannelRes

Command openChanRes.

Optional ot

ot: undefined | null | IOTPacket

Command ot.

Optional otDeleteCursor

otDeleteCursor: undefined | null | IOTCursor

Command otDeleteCursor.

Optional otLinkFile

otLinkFile: undefined | null | IOTLinkFile

Command otLinkFile.

Optional otNewCursor

otNewCursor: undefined | null | IOTCursor

Command otNewCursor.

Optional otstatus

otstatus: undefined | null | IOTStatus

Command otstatus.

output

output: string

Command output.

Optional packageAdd

packageAdd: undefined | null | IPackageAdd

Command packageAdd.

Optional packageCacheSave

packageCacheSave: undefined | null | IPackageCacheSave

Command packageCacheSave.

Optional packageInfo

packageInfo: undefined | null | IPackageInfo

Command packageInfo.

Optional packageInfoResp

packageInfoResp: undefined | null | IPackageInfoResp

Command packageInfoResp.

Optional packageInstall

packageInstall: undefined | null | IPackageInstall

Command packageInstall.

Optional packageListSpecfile

packageListSpecfile: undefined | null | IPackageListSpecfile

Command packageListSpecfile.

Optional packageListSpecfileResp

packageListSpecfileResp: undefined | null | IPackageListSpecfileResp

Command packageListSpecfileResp.

Optional packageRemove

packageRemove: undefined | null | IPackageRemove

Command packageRemove.

Optional packageSearch

packageSearch: undefined | null | IPackageSearch

Command packageSearch.

Optional packageSearchResp

packageSearchResp: undefined | null | IPackageSearchResp

Command packageSearchResp.

Optional part

part: undefined | null | IUser

Command part.

Optional persist

persist: undefined | null | IFile

Command persist.

Optional ping

ping: undefined | null | IPing

Command ping.

Optional pong

pong: undefined | null | IPong

Command pong.

Optional portOpen

portOpen: undefined | null | IPortOpen

Command portOpen.

Optional read

read: undefined | null | IFile

Command read.

Optional readVCR

readVCR: undefined | null | IReadVCR

Command readVCR.

Optional readdir

readdir: undefined | null | IFile

Command readdir.

Optional recv

recv: undefined | null | IRecv

Command recv.

ref

ref: string

Command ref.

Optional remove

remove: undefined | null | IFile

Command remove.

Optional resizeTerm

resizeTerm: undefined | null | IResizeTerm

Command resizeTerm.

result

result: string

Command result.

Optional roster

roster: undefined | null | IRoster

Command roster.

Optional runContainedTest

runContainedTest: undefined | null | IContainedTest

Command runContainedTest.

Optional runMain

runMain: undefined | null | IRunMain

Command runMain.

Optional saneTerm

saneTerm: undefined | null | ISaneTerm

Command saneTerm.

Optional send

send: undefined | null | ISend

Command send.

session

session: number

Command session.

Optional startVCR

startVCR: undefined | null | IStartVCR

Command startVCR.

state

state: State

Command state.

Optional subscribe

subscribe: undefined | null | IFile

Command subscribe.

Optional subscribeFile

subscribeFile: undefined | null | ISubscribeFile

Command subscribeFile.

Optional testResult

testResult: undefined | null | ITestResult

Command testResult.

Optional toast

toast: undefined | null | IToast

Command toast.

Optional write

write: undefined | null | IFile

Command write.

Methods

toJSON

  • toJSON(): object
  • Converts this Command to JSON.

    Returns object

    JSON object

    • [k: string]: any

Static create

  • Creates a new Command instance using the specified properties.

    Parameters

    Returns Command

    Command instance

Static decode

  • decode(reader: Reader | Uint8Array, length?: undefined | number): Command
  • Decodes a Command message from the specified reader or buffer.

    throws

    {Error} If the payload is not a reader or valid buffer

    throws

    {$protobuf.util.ProtocolError} If required fields are missing

    Parameters

    • reader: Reader | Uint8Array

      Reader or buffer to decode from

    • Optional length: undefined | number

    Returns Command

    Command

Static decodeDelimited

  • decodeDelimited(reader: Reader | Uint8Array): Command
  • Decodes a Command message from the specified reader or buffer, length delimited.

    throws

    {Error} If the payload is not a reader or valid buffer

    throws

    {$protobuf.util.ProtocolError} If required fields are missing

    Parameters

    • reader: Reader | Uint8Array

      Reader or buffer to decode from

    Returns Command

    Command

Static encode

  • encode(message: ICommand, writer?: $protobuf.Writer): Writer
  • Encodes the specified Command message. Does not implicitly verify messages.

    Parameters

    • message: ICommand

      Command message or plain object to encode

    • Optional writer: $protobuf.Writer

    Returns Writer

    Writer

Static encodeDelimited

  • encodeDelimited(message: ICommand, writer?: $protobuf.Writer): Writer
  • Encodes the specified Command message, length delimited. Does not implicitly verify messages.

    Parameters

    • message: ICommand

      Command message or plain object to encode

    • Optional writer: $protobuf.Writer

    Returns Writer

    Writer

Static fromObject

  • fromObject(object: object): Command
  • Creates a Command message from a plain object. Also converts values to their respective internal types.

    Parameters

    • object: object

      Plain object

      • [k: string]: any

    Returns Command

    Command

Static toObject

  • toObject(message: Command, options?: $protobuf.IConversionOptions): object
  • Creates a plain object from a Command message. Also converts values to other types if specified.

    Parameters

    • message: Command

      Command

    • Optional options: $protobuf.IConversionOptions

    Returns object

    Plain object

    • [k: string]: any

Static verify

  • verify(message: object): null | string
  • Verifies a Command message.

    Parameters

    • message: object

      Plain object to verify

      • [k: string]: any

    Returns null | string

    null if valid, otherwise the reason why it is not

Generated using TypeDoc