Class RequestTransactionDataSchema

Class RequestTransactionDataSchema describes a transaction request QR code data schema.

since: 0.3.0

Hierarchy

QRCodeDataSchema
- RequestTransactionDataSchema
  - RequestCosignatureDataSchema

Index

Constructors

constructor

Properties

VERSION

Methods

Constructors

constructor

new RequestTransactionDataSchema(): RequestTransactionDataSchema

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

Properties

Readonly VERSION

VERSION: 3 = 3

The AccountQR QR Code version

var: {number}

Methods

getData

getData(qr: TransactionQR): any

Overrides QRCodeDataSchema.getData
- Defined in schemas/RequestTransactionDataSchema.ts:44
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 QRCodeDataSchema.toObject
- Defined in QRCodeDataSchema.ts:54
The toObject() method returns a JSON object with required fields.

Parameters
- qr: QRCode
Returns any

Static parse

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

- Defined in schemas/RequestTransactionDataSchema.ts:65
Parse a JSON QR code content into a TransactionQR 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 TransactionQR

Generated using TypeDoc