Class BoxDescriptor

constructor

• new BoxDescriptor(__namedParameters): modelsv2.BoxDescriptor

• Creates a new BoxDescriptor object.

  Parameters

  • __namedParameters: {
        name: string | Uint8Array;
        value?: string | Uint8Array;
    }

    • name: string | Uint8Array

    • Optional value?: string | Uint8Array

  Returns modelsv2.BoxDescriptor

name

Optional value

Static encodingSchema

• get encodingSchema(): Schema

• Returns Schema

getEncodingSchema

• getEncodingSchema(): Schema

• Get the encoding Schema for this object, used to prepare the encoding data for msgpack and JSON.

  Returns Schema

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>

Static fromEncodingData

• fromEncodingData(data): modelsv2.BoxDescriptor

• Parameters

  • data: unknown

  Returns modelsv2.BoxDescriptor