Class BoxReference

BoxReference names a box by its name and the application ID it belongs to.

Implements

Encodable

Index

Constructors

Properties

app name encodingSchemaValue

Accessors

Methods

getEncodingSchema toEncodingData fromEncodingData

Constructors

constructor

new BoxReference(__namedParameters): indexerModels.BoxReference
Creates a new BoxReference object.
Parameters
- __namedParameters: {
  app: number | bigint;
  name: string | Uint8Array;
  }
  - app: number | bigint
  - name: string | Uint8Array
Returns indexerModels.BoxReference
- Defined in client/v2/indexer/models/types.ts:4053

Properties

app

app: number

Application ID to which the box belongs, or zero if referring to the called application.

name

name: Uint8Array

Base64 encoded box name

`Static` `Private` encodingSchemaValue

encodingSchemaValue: undefined | Schema

Accessors

`Static` encodingSchema

get encodingSchema(): Schema
Returns Schema
- Defined in client/v2/indexer/models/types.ts:4025

Methods

getEncodingSchema

getEncodingSchema(): Schema
Get the encoding Schema for this object, used to prepare the encoding data for msgpack and JSON.

Returns Schema
Implementation of Encodable.getEncodingSchema
- Defined in client/v2/indexer/models/types.ts:4065

toEncodingData

toEncodingData(): Map<string, unknown>
Extract the encoding data for this object. This data, after being prepared by the encoding Schema, can be encoded to msgpack or JSON.

Returns Map<string, unknown>
Implementation of Encodable.toEncodingData
- Defined in client/v2/indexer/models/types.ts:4069

`Static` fromEncodingData

fromEncodingData(data): indexerModels.BoxReference
Parameters
- data: unknown
Returns indexerModels.BoxReference
- Defined in client/v2/indexer/models/types.ts:4076

Generated using TypeDoc