Class CreateSingleUseCodePacket

Command to create a single-use code.

Hierarchy (View Summary)

AuthPacket
- CreateSingleUseCodePacket

Index

Constructors

Properties

configKey pin rawPayload opcode

Accessors

Methods

encode toPayload extractConfigKey fromPayload

Constructors

constructor

new CreateSingleUseCodePacket(
configKey: string,
pin: string,
): CreateSingleUseCodePacket
Parameters
- configKey: string
- pin: string
Returns CreateSingleUseCodePacket
Overrides AuthPacket.constructor
- Defined in src/protocol/downlink/CreateSingleUseCodePacket.ts:15

Properties

`Readonly`configKey

configKey: string

`Readonly`pin

pin: string

`Protected`rawPayload

rawPayload: Uint8Array = ...

`Static` `Readonly`opcode

opcode: CREATE_SINGLE_USE_CODE = BoksOpcode.CREATE_SINGLE_USE_CODE

Accessors

opcode

get opcode(): BoksOpcode
Returns BoksOpcode
Overrides AuthPacket.opcode
- Defined in src/protocol/downlink/CreateSingleUseCodePacket.ts:11

Methods

encode

encode(): Uint8Array
Encodes the full packet: [Opcode, Length, ...Payload, Checksum]

Returns Uint8Array
Inherited from AuthPacket.encode
- Defined in src/protocol/_BoksPacketBase.ts:35

toPayload

toPayload(): Uint8Array
Returns Uint8Array
Overrides AuthPacket.toPayload
- Defined in src/protocol/downlink/CreateSingleUseCodePacket.ts:29

`Static`extractConfigKey

extractConfigKey(payload: Uint8Array): string
Helper to quickly extract the config key string from a standard AuthPacket payload.
Parameters
- payload: Uint8Array
Returns string
Inherited from AuthPacket.extractConfigKey
- Defined in src/protocol/downlink/_AuthPacketBase.ts:24

`Static`fromPayload

fromPayload(payload: Uint8Array): CreateSingleUseCodePacket
Static factory method to create an instance from a payload. This MUST be implemented by leaf classes for strict parsing.
Parameters
- payload: Uint8Array
Returns CreateSingleUseCodePacket
Overrides AuthPacket.fromPayload
- Defined in src/protocol/downlink/CreateSingleUseCodePacket.ts:23