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

objectId

readonly objectId: string

Source

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

prefix

prefix?: string

Inherited from

ChainCallDTO.prefix

Source

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

signature

signature?: string

Inherited from

ChainCallDTO.signature

Source

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

signerAddress

signerAddress?: string

Inherited from

ChainCallDTO.signerAddress

Source

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

signerPublicKey

signerPublicKey?: string

Inherited from

ChainCallDTO.signerPublicKey

Source

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

signing

signing?: SigningScheme

Inherited from

ChainCallDTO.signing

Source

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

trace

trace?: TraceContext

Inherited from

ChainCallDTO.trace

Source

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

uniqueKey

uniqueKey?: string

Inherited from

ChainCallDTO.uniqueKey

Source

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

ENCODING

static readonly ENCODING: "base64" = "base64"

Inherited from

ChainCallDTO.ENCODING

Source

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

Methods

isSignatureValid()

isSignatureValid(publicKey): boolean

Parameters

▪ publicKey: string

Inherited from

ChainCallDTO.isSignatureValid

Source

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

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

sign()

sign(privateKey, useDer): void

Parameters

▪ privateKey: string

▪ useDer: boolean= false

Inherited from

ChainCallDTO.sign

Source

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

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

validate()

validate(): Promise\<ValidationError[]>

Inherited from

ChainCallDTO.validate

Source

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

validateOrReject()

validateOrReject(): Promise\<void>

Inherited from

ChainCallDTO.validateOrReject

Source

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

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