Skip to main content

BarcodeContentType

Interfaces

IEmptyBarcodeContent

A structure defining the content of empty barcode placeholders.

Extended by

Type Parameters

Type Parameter
TBarcodeFormat
TBarcodeSubType

Properties

barcodeFormat?
optional barcodeFormat?: TBarcodeFormat;

The barcode format.

barcodeSubType?
optional barcodeSubType?: TBarcodeSubType;

The barcode subtype.


ILinearBarcodeContent

A structure defining the content of linear barcodes.

Extends

Type Parameters

Type Parameter
TBarcodeFormat
TBarcodeSubType

Properties

barcodeFormat?
optional barcodeFormat?: TBarcodeFormat;

The barcode format.

Inherited from

IEmptyBarcodeContent.barcodeFormat

barcodeSubType?
optional barcodeSubType?: TBarcodeSubType;

The barcode subtype.

Inherited from

IEmptyBarcodeContent.barcodeSubType

barcodeValue?
optional barcodeValue?: string;

A value encoded into the barcode.


IQrPhoneBarcodeContent

A structure defining the content of VCard QR codes.

Extends

Type Parameters

Type Parameter
TBarcodeFormat
TBarcodeSubType

Properties

barcodeFormat?
optional barcodeFormat?: TBarcodeFormat;

The barcode format.

Inherited from

IEmptyBarcodeContent.barcodeFormat

barcodeSubType?
optional barcodeSubType?: TBarcodeSubType;

The barcode subtype.

Inherited from

IEmptyBarcodeContent.barcodeSubType

phone?
optional phone?: string;

A phone number encoded into the QR code.


IQrUrlBarcodeContent

A structure defining the content of URL QR codes.

Example

{
"defaultItemsConfig": {
"barcode": {
"barcodeContent": {
"barcodeFormat": "QrUrl",
"url": "example.com"
}
}
}
}

Extends

Type Parameters

Type Parameter
TBarcodeFormat
TBarcodeSubType

Properties

barcodeFormat?
optional barcodeFormat?: TBarcodeFormat;

The barcode format.

Inherited from

IEmptyBarcodeContent.barcodeFormat

barcodeSubType?
optional barcodeSubType?: TBarcodeSubType;

The barcode subtype.

Inherited from

IEmptyBarcodeContent.barcodeSubType

url?
optional url?: string;

A URL encoded into the QR code.


IQrVCardBarcodeContent

A structure defining the content of VCard QR codes.

Extends

Type Parameters

Type Parameter
TBarcodeFormat
TBarcodeSubType

Properties

barcodeFormat?
optional barcodeFormat?: TBarcodeFormat;

The barcode format.

Inherited from

IEmptyBarcodeContent.barcodeFormat

barcodeSubType?
optional barcodeSubType?: TBarcodeSubType;

The barcode subtype.

Inherited from

IEmptyBarcodeContent.barcodeSubType

email?
optional email?: string;

An email address encoded into the QR code.

firstName?
optional firstName?: string;

A first name encoded into the QR code.

lastName?
optional lastName?: string;

A last name encoded into the QR code.

mobilePhone?
optional mobilePhone?: string;

A cell phone number encoded into the QR code.

organization?
optional organization?: string;

An organization name encoded into the QR code.

phone?
optional phone?: string;

A work phone number encoded into the QR code.

position?
optional position?: string;

A job position encoded into the QR code.

url?
optional url?: string;

A URL encoded into the QR code.


IStubBarcodeContent

A structure defining the content of stub barcode placeholders.

Example

{
"defaultItemsConfig": {
"stubImages": {
"barcode": {
"postScriptName": "LucidaSans-Italic",
"text": "Define a Barcode"
}
}
}
}

Extends

Type Parameters

Type Parameter
TBarcodeFormat
TBarcodeSubType

Properties

barcodeFormat?
optional barcodeFormat?: TBarcodeFormat;

The barcode format.

Inherited from

IEmptyBarcodeContent.barcodeFormat

barcodeSubType?
optional barcodeSubType?: TBarcodeSubType;

The barcode subtype.

Inherited from

IEmptyBarcodeContent.barcodeSubType

postScriptName?
optional postScriptName?: string;

The font PostScript name of the text message in the stub barcode placeholder.

text?
optional text?: string;

The text message in the stub barcode placeholder.

Type Aliases

BarcodeContentType

type BarcodeContentType<TBarcodeFormat, TBarcodeSubType> =
| IEmptyBarcodeContent<TBarcodeFormat, TBarcodeSubType>
| IStubBarcodeContent<TBarcodeFormat, TBarcodeSubType>
| ILinearBarcodeContent<TBarcodeFormat, TBarcodeSubType>
| IQrVCardBarcodeContent<TBarcodeFormat, TBarcodeSubType>
| IQrUrlBarcodeContent<TBarcodeFormat, TBarcodeSubType>
| IQrPhoneBarcodeContent<TBarcodeFormat, TBarcodeSubType>;

Info encoded in the barcode.

Type Parameters

Type Parameter
TBarcodeFormat
TBarcodeSubType
Was this page helpful?