Class PayloadSignature

A representation of a Payload Signature.

Index

Constructors

Properties

Methods

getAddressId getId getSignature getStatus getUnsignedPayload getWalletId isTerminalState reload toString wait

Constructors

constructor

new PayloadSignature(model): PayloadSignature
Constructs a Payload Signature.
Parameters
- model: PayloadSignature
  The underlying Payload Signature object.
Returns PayloadSignature
- Defined in src/coinbase/payload_signature.ts:19

Properties

`Private` model

model: PayloadSignature

Methods

getAddressId

getAddressId(): string
Returns the Address ID of the Payload Signature.

Returns string
The Address ID
- Defined in src/coinbase/payload_signature.ts:49

getId

getId(): string
Returns the ID of the Payload Signature.

Returns string
The ID of the Payload Signature
- Defined in src/coinbase/payload_signature.ts:31

getSignature

getSignature(): undefined | string
Returns the Signature of the Payload Signature.

Returns undefined | string
The Signature
- Defined in src/coinbase/payload_signature.ts:67

getStatus

getStatus(): undefined | PayloadSignatureStatus
Returns the Status of the Payload Signature.

Returns undefined | PayloadSignatureStatus
The Status
- Defined in src/coinbase/payload_signature.ts:76

getUnsignedPayload

getUnsignedPayload(): string
Returns the Unsigned Payload of the Payload Signature.

Returns string
The Unsigned Payload
- Defined in src/coinbase/payload_signature.ts:58

getWalletId

getWalletId(): string
Returns the Wallet ID of the Payload Signature.

Returns string
The Wallet ID
- Defined in src/coinbase/payload_signature.ts:40

isTerminalState

isTerminalState(): boolean
Returns whether the Payload Signature is in a terminal State.

Returns boolean
Whether the Payload Signature is in a terminal State
- Defined in src/coinbase/payload_signature.ts:94

reload

reload(): Promise<void>
Reloads the Payload Signature model with the latest data from the server.

Returns Promise<void>
Throws
if the API request to get a Payload Signature fails.
- Defined in src/coinbase/payload_signature.ts:137

toString

toString(): string
Returns a string representation of the Payload Signature.

Returns string
A string representation of the Payload Signature.
- Defined in src/coinbase/payload_signature.ts:151

wait

wait(options?): Promise<PayloadSignature>
Waits for the Payload Signature to be signed or for the signature operation to fail.
Parameters
- options: {
  intervalSeconds: undefined | number;
  timeoutSeconds: undefined | number;
  } = {}
  The options to configure the wait function.
  - intervalSeconds: undefined | number
    The interval to check the status of the Payload Signature.
  - timeoutSeconds: undefined | number
    The maximum time to wait for the Payload Signature to be confirmed.
Returns Promise<PayloadSignature>
The Payload Signature object in a terminal state.

Throws
if the Payload Signature times out.
- Defined in src/coinbase/payload_signature.ts:112