Class RequestCosignatureDataSchema

Class RequestCosignatureDataSchema describes a transaction cosignature request QR code data schema.

since: 0.3.0

Hierarchy

RequestTransactionDataSchema
- RequestCosignatureDataSchema

Index

Constructors

constructor

Properties

VERSION

Methods

Constructors

constructor

new RequestCosignatureDataSchema(): RequestCosignatureDataSchema

Overrides RequestTransactionDataSchema.constructor
- Defined in schemas/RequestCosignatureDataSchema.ts:33
Returns RequestCosignatureDataSchema

Properties

Readonly VERSION

VERSION: 3 = 3

The AccountQR QR Code version

var: {number}

Methods

getData

getData(qr: TransactionQR): any

Inherited from RequestTransactionDataSchema.getData
- Defined in schemas/RequestTransactionDataSchema.ts:45
The getData() method returns an object that will be stored in the data field of the underlying QR Code JSON content.

Parameters
- qr: TransactionQR
Returns any

toObject

toObject(qr: QRCode): any

Inherited from RequestTransactionDataSchema.toObject
- Defined in QRCodeDataSchema.ts:55
The toObject() method returns a JSON object with required fields.

Parameters
- qr: QRCode
Returns any

Static parse

parse(json: string, transactionCreateFromPayload: (payload: string) => ITransaction): CosignatureQR

Overrides RequestTransactionDataSchema.parse
- Defined in schemas/RequestCosignatureDataSchema.ts:48
Parse a JSON QR code content into a CosignatureQR object.

throws
{Error} On empty json given.

throws
{Error} On missing type field value.

throws
{Error} On unrecognized QR code type field value.

Parameters
- json: string
- transactionCreateFromPayload: (payload: string) => ITransaction
  
  the transaction parser that creates a transaction from a binary payload.
  - - (payload: string): ITransaction
    - Parameters
      - payload: string
      Returns ITransaction
Returns CosignatureQR

Generated using TypeDoc