Class ApplicationKVStorage

An application's global/local/box state.

Hierarchy

BaseModel
- ApplicationKVStorage

Index

Constructors

Properties

account attribute_map kvs

Methods

get_obj_for_encoding from_obj_for_encoding

Constructors

constructor

new ApplicationKVStorage(__namedParameters: { account?: string; kvs: AvmKeyValue[] }): ApplicationKVStorage
Creates a new ApplicationKVStorage object.
Parameters
- __namedParameters: { account?: string; kvs: AvmKeyValue[] }
  - Optional account?: string
  - kvs: AvmKeyValue[]
Returns ApplicationKVStorage
Overrides BaseModel.constructor
- Defined in client/v2/algod/models/types.ts:889

Properties

`Optional` account

account?: string

The address of the account associated with the local state.

attribute_map

attribute_map: Record<string, string>

kvs

kvs: AvmKeyValue[]

Key-Value pairs representing application states.

Methods

get_obj_for_encoding

get_obj_for_encoding(binary?: boolean): Record<string, any>
Get an object ready for encoding to either JSON or msgpack.
Parameters
- binary: boolean = false
  
  Use true to indicate that the encoding can handle raw binary objects (Uint8Arrays). Use false to indicate that raw binary objects should be converted to base64 strings. True should be used for objects that will be encoded with msgpack, and false should be used for objects that will be encoded with JSON.
Returns Record<string, any>
Inherited from BaseModel.get_obj_for_encoding
- Defined in client/v2/basemodel.ts:65

`Static` from_obj_for_encoding

from_obj_for_encoding(data: Record<string, any>): ApplicationKVStorage
Parameters
- data: Record<string, any>
Returns ApplicationKVStorage
- Defined in client/v2/algod/models/types.ts:901

Generated using TypeDoc