Google Cloud Document Ai V1 Client - Class Barcode (1.0.1)

Version 1.0.1

• 2.1.1 (latest)
• 2.1.0
• 2.0.0
• 1.14.0
• 1.13.1
• 1.12.2
• 1.9.0
• 1.8.2
• 1.7.0
• 1.6.0
• 1.5.0
• 1.4.0
• 1.3.0
• 1.2.2
• 1.1.1
• 1.0.1

Reference documentation and code samples for the Google Cloud Document Ai V1 Client class Barcode.

Encodes the detailed information of a barcode.

Generated from protobuf message google.cloud.documentai.v1.Barcode

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ format	string Format of a barcode. The supported formats are: - CODE_128: Code 128 type. - CODE_39: Code 39 type. - CODE_93: Code 93 type. - CODABAR: Codabar type. - DATA_MATRIX: 2D Data Matrix type. - ITF: ITF type. - EAN_13: EAN-13 type. - EAN_8: EAN-8 type. - QR_CODE: 2D QR code type. - UPC_A: UPC-A type. - UPC_E: UPC-E type. - PDF417: PDF417 type. - AZTEC: 2D Aztec code type. - DATABAR: GS1 DataBar code type.
↳ value_format	string Value format describes the format of the value that a barcode encodes. The supported formats are: - CONTACT_INFO: Contact information. - EMAIL: Email address. - ISBN: ISBN identifier. - PHONE: Phone number. - PRODUCT: Product. - SMS: SMS message. - TEXT: Text string. - URL: URL address. - WIFI: Wifi information. - GEO: Geo-localization. - CALENDAR_EVENT: Calendar event. - DRIVER_LICENSE: Driver's license.
↳ raw_value	string Raw value encoded in the barcode. For example: 'MEBKM:TITLE:Google;URL:https://www.google.com;;'.

getFormat

Format of a barcode.

The supported formats are:

• CODE_128: Code 128 type.
• CODE_39: Code 39 type.
• CODE_93: Code 93 type.
• CODABAR: Codabar type.
• DATA_MATRIX: 2D Data Matrix type.
• ITF: ITF type.
• EAN_13: EAN-13 type.
• EAN_8: EAN-8 type.
• QR_CODE: 2D QR code type.
• UPC_A: UPC-A type.
• UPC_E: UPC-E type.
• PDF417: PDF417 type.
• AZTEC: 2D Aztec code type.
• DATABAR: GS1 DataBar code type.

Generated from protobuf field string format = 1;

Returns
Type	Description
string

setFormat

Format of a barcode.

The supported formats are:

• CODE_128: Code 128 type.
• CODE_39: Code 39 type.
• CODE_93: Code 93 type.
• CODABAR: Codabar type.
• DATA_MATRIX: 2D Data Matrix type.
• ITF: ITF type.
• EAN_13: EAN-13 type.
• EAN_8: EAN-8 type.
• QR_CODE: 2D QR code type.
• UPC_A: UPC-A type.
• UPC_E: UPC-E type.
• PDF417: PDF417 type.
• AZTEC: 2D Aztec code type.
• DATABAR: GS1 DataBar code type.

Generated from protobuf field string format = 1;

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getValueFormat

Value format describes the format of the value that a barcode encodes.

The supported formats are:

• CONTACT_INFO: Contact information.
• EMAIL: Email address.
• ISBN: ISBN identifier.
• PHONE: Phone number.
• PRODUCT: Product.
• SMS: SMS message.
• TEXT: Text string.
• URL: URL address.
• WIFI: Wifi information.
• GEO: Geo-localization.
• CALENDAR_EVENT: Calendar event.
• DRIVER_LICENSE: Driver's license.

Generated from protobuf field string value_format = 2;

Returns
Type	Description
string

setValueFormat

Value format describes the format of the value that a barcode encodes.

The supported formats are:

• CONTACT_INFO: Contact information.
• EMAIL: Email address.
• ISBN: ISBN identifier.
• PHONE: Phone number.
• PRODUCT: Product.
• SMS: SMS message.
• TEXT: Text string.
• URL: URL address.
• WIFI: Wifi information.
• GEO: Geo-localization.
• CALENDAR_EVENT: Calendar event.
• DRIVER_LICENSE: Driver's license.

Generated from protobuf field string value_format = 2;

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getRawValue

Raw value encoded in the barcode.

For example: 'MEBKM:TITLE:Google;URL:https://www.google.com;;'.

Generated from protobuf field string raw_value = 3;

Returns
Type	Description
string

setRawValue

Raw value encoded in the barcode.

For example: 'MEBKM:TITLE:Google;URL:https://www.google.com;;'.

Generated from protobuf field string raw_value = 3;

Parameter
Name	Description
var	string

Returns
Type	Description
$this