Class BoxesResponse

Box names of an application

Implements

Encodable

Index

Constructors

Properties

applicationId boxes nextToken? encodingSchemaValue

Accessors

Methods

getEncodingSchema toEncodingData fromEncodingData

Constructors

constructor

new BoxesResponse(__namedParameters): indexerModels.BoxesResponse
Creates a new BoxesResponse object.
Parameters
- __namedParameters: {
      applicationId: number | bigint;
      boxes: indexerModels.BoxDescriptor[];
      nextToken?: string;
  }
  - applicationId: number | bigint
  - boxes: indexerModels.BoxDescriptor[]
  - Optional nextToken?: string
Returns indexerModels.BoxesResponse
- Defined in client/v2/indexer/models/types.ts:3961

Properties

applicationId

applicationId: bigint

(appidx) application index.

boxes

boxes: indexerModels.BoxDescriptor[]

`Optional` nextToken

nextToken?: string

Used for pagination, when making another request provide this token with the next parameter.

`Static` `Private` encodingSchemaValue

encodingSchemaValue: undefined | Schema

Accessors

`Static` encodingSchema

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

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:3976

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:3980

`Static` fromEncodingData

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

Generated using TypeDoc