Class ExportAddressDataSchema

Class ExportAddressDataSchema describes a contact add QR code data schema.

since: 0.3.0

Hierarchy

QRCodeDataSchema
- ExportAddressDataSchema

Index

Constructors

constructor

Properties

VERSION

Methods

Constructors

constructor

new ExportAddressDataSchema(): ExportAddressDataSchema

Overrides QRCodeDataSchema.constructor
- Defined in schemas/ExportAddressDataSchema.ts:32
Returns ExportAddressDataSchema

Properties

Readonly VERSION

VERSION: 3 = 3

The AccountQR QR Code version

var: {number}

Methods

getData

getData(qr: AddressQR): any

Overrides QRCodeDataSchema.getData
- Defined in schemas/ExportAddressDataSchema.ts:43
The getData() method returns an object that will be stored in the data field of the underlying QR Code JSON content.

Parameters
- qr: AddressQR
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): AddressQR

- Defined in schemas/ExportAddressDataSchema.ts:60
Parse a JSON QR code content into a ContactQR 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
Returns AddressQR

Generated using TypeDoc