Skip to content

@gala-chain/api ∙ API

API > GetObjectDto

Class: GetObjectDto

Contents

Description

Input for the GetObjectByKey chaincode method defined on the GalaContract class.

Extends

Constructors

new GetObjectDto()

new GetObjectDto(): GetObjectDto

Inherited from

ChainCallDTO.constructor

Properties

dtoExpiresAt

dtoExpiresAt?: number

Inherited from

ChainCallDTO.dtoExpiresAt

Source

chain-api/src/types/dtos.ts:224

dtoOperation

dtoOperation?: string

Inherited from

ChainCallDTO.dtoOperation

Source

chain-api/src/types/dtos.ts:217

multisig

multisig?: string[]

Inherited from

ChainCallDTO.multisig

Source

chain-api/src/types/dtos.ts:206

objectId

readonly objectId: string

Source

chain-api/src/types/dtos.ts:425

prefix

prefix?: string

Inherited from

ChainCallDTO.prefix

Source

chain-api/src/types/dtos.ts:169

signature

signature?: string

Inherited from

ChainCallDTO.signature

Source

chain-api/src/types/dtos.ts:193

signerAddress

signerAddress?: UserRef

Inherited from

ChainCallDTO.signerAddress

Source

chain-api/src/types/dtos.ts:176

signerPublicKey

signerPublicKey?: string

Inherited from

ChainCallDTO.signerPublicKey

Source

chain-api/src/types/dtos.ts:183

uniqueKey

uniqueKey?: string

Inherited from

ChainCallDTO.uniqueKey

Source

chain-api/src/types/dtos.ts:160

Methods

expiresInMs()

expiresInMs(ms): GetObjectDto

Parameters

▪ ms: number

Inherited from

ChainCallDTO.expiresInMs

Source

chain-api/src/types/dtos.ts:339

getAllSignatures()

getAllSignatures(): string[]

Inherited from

ChainCallDTO.getAllSignatures

Source

chain-api/src/types/dtos.ts:276

isSignatureValid()

isSignatureValid(publicKey): boolean

Parameters

▪ publicKey: string

Inherited from

ChainCallDTO.isSignatureValid

Source

chain-api/src/types/dtos.ts:357

serialize()

serialize(): string

Returns

string

Inherited from

ChainCallDTO.serialize

Description

Serialze this object to string in a determinsitic fashion. See Hyperledger Fabric's documentation on JSON Determinism for more details.

Source

chain-api/src/types/dtos.ts:248

sign()

sign(privateKey, useDer): void

Parameters

▪ privateKey: string

▪ useDer: boolean= false

Inherited from

ChainCallDTO.sign

Source

chain-api/src/types/dtos.ts:280

signed()

signed(privateKey, useDer): GetObjectDto

Creates a signed copy of current object.

Parameters

▪ privateKey: string

▪ useDer: boolean= false

Inherited from

ChainCallDTO.signed

Source

chain-api/src/types/dtos.ts:333

validate()

validate(): Promise\<ValidationError[]>

Inherited from

ChainCallDTO.validate

Source

chain-api/src/types/dtos.ts:226

validateOrReject()

validateOrReject(): Promise\<void>

Inherited from

ChainCallDTO.validateOrReject

Source

chain-api/src/types/dtos.ts:230

withOperation()

withOperation(operation): GetObjectDto

Parameters

▪ operation: string

Inherited from

ChainCallDTO.withOperation

Source

chain-api/src/types/dtos.ts:345

withSigner()

withSigner(ref): GetObjectDto

Parameters

▪ ref: UserRef

Inherited from

ChainCallDTO.withSigner

Source

chain-api/src/types/dtos.ts:351

deserialize()

static deserialize\<T>(constructor, object): T

Type parameters

▪ T

Parameters

▪ constructor: ClassConstructor\<Inferred\<T, ChainCallDTO>>

ClassConstructor that extends ChainCallDTO

▪ object: string | Record\<string, unknown> | Record\<string, unknown>[]

serialized string or plain object to be instantiated via the provided ClassConstructor

Returns

An instantiated class created with the provided ClassConstructor

Inherited from

ChainCallDTO.deserialize

Description

Instantiate a class instance from a serialized object using the provided ClassConstructor.

Source

chain-api/src/types/dtos.ts:269