Class ContactQR

Hierarchy

QRCode
- ContactQR

Implements

QRCodeInterface

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new ContactQR(name: string, accountPublicKey: string, networkType: number, generationHash: string): ContactQR

Overrides QRCode.constructor
- Defined in ContactQR.ts:38
Construct a Contact QR Code out of the symbol public key.

Parameters
- name: string
  
  the contact name.
- accountPublicKey: string
  
  the public key
- networkType: number
- generationHash: string
Returns ContactQR

Properties

Readonly accountPublicKey

accountPublicKey: string

Optional Readonly base64

base64?: string

Readonly encrypted

encrypted: boolean = false

Readonly generationHash

generationHash: string

Readonly name

name: string

Readonly networkType

networkType: number

Readonly type

type: QRCodeType

The type of the QR Code.

Methods

getCorrectionLevel

getCorrectionLevel(): CorrectionLevel

Inherited from QRCode.getCorrectionLevel
- Defined in QRCode.ts:98
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 ContactQR.ts:98
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 ContactQR.ts:85
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 QRCode.ts:130
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
- settings: 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 QRCode.ts:202
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
- settings: QRCodeSettings = ...
  
  (Optional) Settings for generation
Returns Observable<string>

toJSON

toJSON(): string

Implementation of QRCodeInterface.toJSON
Inherited from QRCode.toJSON
- Defined in QRCode.ts:108
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 QRCode.ts:178
Generate QRCode and return object.

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

Parameters
- settings: 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 QRCode.ts:154
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
- settings: QRCodeSettings = ...
  
  (Optional) Settings for generation
- streamType: QRCodeStreamType = QRCodeStreamType.Terminal
  
  (Optional) The QR Code text type, defaults to "terminal"
Returns Observable<string>

Static fromJSON

fromJSON(json: string): ContactQR

- Defined in ContactQR.ts:70
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 ContactQR

Generated using TypeDoc