Class TransactionQR

Hierarchy

QRCode
- TransactionQR
  - CosignatureQR

Implements

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new TransactionQR(transaction: Transaction, networkType: NetworkType, generationHash: string, type?: QRCodeType): TransactionQR

Overrides QRCode.constructor
- Defined in src/TransactionQR.ts:30
Construct a Transaction Request QR Code out of the symbol-sdk Transaction instance.

Parameters
- transaction: Transaction
- networkType: NetworkType
- generationHash: string
- Default value type: QRCodeType = QRCodeType.RequestTransaction
Returns TransactionQR

Properties

Optional base64

base64: string

generationHash

generationHash: string

networkType

networkType: NetworkType

The network type.

var: {NetworkType}

transaction

transaction: Transaction

The transaction for the request.

var: {Transaction}

type

type: QRCodeType

The QR Code Type

var: {QRCodeType}

Methods

getCorrectionLevel

getCorrectionLevel(): CorrectionLevel

Inherited from QRCode.getCorrectionLevel
- Defined in src/QRCode.ts:92
The getCorrectionLevel() method should return the QR Code correction level.

Sub-classes may overload this method to provide with a different correction level.

Returns CorrectionLevel

getSchema

getSchema(): QRCodeDataSchema

Overrides QRCode.getSchema
- Defined in src/TransactionQR.ts:101
The getSchema() method should return an instance of a sub-class of QRCodeDataSchema which describes the QR Code data.

Returns QRCodeDataSchema

getTypeNumber

getTypeNumber(): number

Overrides QRCode.getTypeNumber
- Defined in src/TransactionQR.ts:88
The getTypeNumber() method should return the version number for QR codes of the underlying class.

see

https://en.wikipedia.org/wiki/QR_code#Storage

Returns number

toBase64

toBase64(settings?: QRCodeSettings): Observable<string>

Implementation of QRCodeInterface.toBase64

Inherited from QRCode.toBase64
- Defined in src/QRCode.ts:124
Generate QRcode image Base64.

The returned string can be put in the src attribute of a <img /> tag directly in HTML. The produced image will be a PNG.

Parameters
- Default value settings: QRCodeSettings = new QRCodeSettings()
  
  (Optional) Settings for generation
Returns Observable<string>

Return image data in Base64.

toCanvas

toCanvas(settings?: QRCodeSettings): Observable<string>

Inherited from QRCode.toCanvas
- Defined in src/QRCode.ts:196
Generate QRCode to be printed on a node-canvas. This is compatible with the browser and node.

see

https://www.npmjs.com/package/qrcode

see

https://www.npmjs.com/package/canvas

Parameters
- Default value settings: QRCodeSettings = new QRCodeSettings()
  
  (Optional) Settings for generation
Returns Observable<string>

toJSON

toJSON(): string

Implementation of QRCodeInterface.toJSON

Inherited from QRCode.toJSON
- Defined in src/QRCode.ts:102
The toJSON() method should return the JSON representation of the QR Code content.

Returns string

toObject

toObject(settings?: QRCodeSettings): Observable<any>

Inherited from QRCode.toObject
- Defined in src/QRCode.ts:172
Generate QRCode and return object.

see

https://www.npmjs.com/package/qrcode

Parameters
- Default value settings: QRCodeSettings = new QRCodeSettings()
  
  (Optional) Settings for generation
Returns Observable<any>

toString

toString(settings?: QRCodeSettings, streamType?: QRCodeStreamType): Observable<string>

Implementation of QRCodeInterface.toString

Inherited from QRCode.toString
- Defined in src/QRCode.ts:148
Generate QRCode as a string. This permits to display SVG format, Terminal format or utf-8 format.

see

https://www.npmjs.com/package/qrcode

Parameters
- Default value settings: QRCodeSettings = new QRCodeSettings()
  
  (Optional) Settings for generation
- Default value streamType: QRCodeStreamType = QRCodeStreamType.Terminal
  
  (Optional) The QR Code text type, defaults to "terminal"
Returns Observable<string>

Static fromJSON

fromJSON(json: string): TransactionQR

- Defined in src/TransactionQR.ts:73
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
Returns TransactionQR

Generated using TypeDoc