Class LockStateCommand

Base command type for a simple writable command, which has a few values which must all be sent

Hierarchy

BasicWritableCommand<LockStateProps>
- LockStateCommand

Index

Constructors

constructor

new LockStateCommand(index, locked): LockStateCommand
Parameters
- index: number
- locked: boolean
Returns LockStateCommand
Overrides BasicWritableCommand.constructor
- Defined in src/commands/DataTransfer/LockStateCommand.ts:11

Properties

`Protected` _properties

_properties: LockStateProps

`Optional` runOrderGroup

runOrderGroup?: number = 0

Link

ISerializableCommand.runOrderGroup

`Static` `Optional` `Readonly` minimumVersion

minimumVersion?: ProtocolVersion

`Static` `Readonly` rawName

rawName: "LOCK" = 'LOCK'

Accessors

properties

get properties(): Readonly<T>
Returns Readonly<T>
Inherited from BasicWritableCommand.properties
- Defined in src/commands/CommandBase.ts:47

Methods

serialize

serialize(): Buffer
Returns Buffer
Overrides BasicWritableCommand.serialize
- Defined in src/commands/DataTransfer/LockStateCommand.ts:15

Class LockStateCommand

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

index: number

locked: boolean

Returns LockStateCommand

Properties

`Protected` _properties

`Optional` runOrderGroup

Link

`Static` `Optional` `Readonly` minimumVersion

`Static` `Readonly` rawName

Accessors

properties

Returns Readonly<T>

Methods

serialize

Returns Buffer

Settings

Member Visibility

Theme

On This Page

Class LockStateCommand

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

index: number

locked: boolean

Returns LockStateCommand

Properties

Protected _properties

Optional runOrderGroup

Link

Static Optional Readonly minimumVersion

Static Readonly rawName

Accessors

properties

Returns Readonly<T>

Methods

serialize

Returns Buffer

Settings

Member Visibility

Theme

On This Page

`Protected` _properties

`Optional` runOrderGroup

`Static` `Optional` `Readonly` minimumVersion

`Static` `Readonly` rawName