barcode

package
v4.2606.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jun 30, 2026 License: MIT Imports: 18 Imported by: 0

Documentation

Index

Constants

View Source
const (
	PACKAGE_VERSION         = "4.2606.0"
	PACKAGE_NAME            = "go sdk"
	X_ASPOSE_CLIENT         = "x-aspose-client"
	X_ASPOSE_CLIENT_VERSION = "x-aspose-client-version"
)

Variables

View Source
var (
	// ContextOAuth2 takes a oauth2.TokenSource as authentication for the request.
	ContextOAuth2 = contextKey("token")

	// ContextBasicAuth takes BasicAuth as authentication for the request.
	ContextBasicAuth = contextKey("basic")

	// ContextAccessToken takes a string oauth2 access token as authentication for the request.
	ContextAccessToken = contextKey("accesstoken")

	// ContextJWT takes ClientID and ClientSecret to fetch JWT as authentication for the request
	ContextJWT = contextKey("jwt")
)

Functions

func IsNil

func IsNil(i interface{}) bool

IsNil checks if an input is nil

func PtrBool

func PtrBool(v bool) *bool

PtrBool is a helper routine that returns a pointer to given boolean value.

func PtrFloat32

func PtrFloat32(v float32) *float32

PtrFloat32 is a helper routine that returns a pointer to given float value.

func PtrFloat64

func PtrFloat64(v float64) *float64

PtrFloat64 is a helper routine that returns a pointer to given float value.

func PtrInt

func PtrInt(v int) *int

PtrInt is a helper routine that returns a pointer to given integer value.

func PtrInt32

func PtrInt32(v int32) *int32

PtrInt32 is a helper routine that returns a pointer to given integer value.

func PtrInt64

func PtrInt64(v int64) *int64

PtrInt64 is a helper routine that returns a pointer to given integer value.

func PtrString

func PtrString(v string) *string

PtrString is a helper routine that returns a pointer to given string value.

func PtrTime

func PtrTime(v time.Time) *time.Time

PtrTime is helper routine that returns a pointer to given Time value.

Types

type APIClient

type APIClient struct {
	GenerateAPI *GenerateAPIService

	RecognizeAPI *RecognizeAPIService

	ScanAPI *ScanAPIService
	// contains filtered or unexported fields
}

APIClient manages communication with the Aspose.BarCode.Cloud v4.0 specification API v4.0 In most cases there should be only one, shared, APIClient.

func NewAPIClient

func NewAPIClient(cfg *Configuration) *APIClient

NewAPIClient creates a new API client. Requires a userAgent string describing your application. optionally a custom http.Client to allow for advanced features such as caching.

func (*APIClient) ChangeBasePath

func (c *APIClient) ChangeBasePath(path string)

ChangeBasePath to allow switching to mocks

type APIKey

type APIKey struct {
	Key    string
	Prefix string
}

APIKey provides API key based authentication to a request passed via context using ContextAPIKey

type ApiError

type ApiError struct {
	// Gets or sets api error code.
	Code string `json:"code"`
	// Gets or sets error message.
	Message string `json:"message"`
	// Gets or sets error description.
	Description string `json:"description,omitempty"`
	// Gets or sets server datetime.
	DateTime time.Time `json:"dateTime,omitempty"`
	// Gets or sets inner error.
	InnerError *ApiError `json:"innerError,omitempty"`
}

ApiError - Api Error.

type ApiErrorResponse

type ApiErrorResponse struct {
	// Gets or sets request Id.
	RequestId string `json:"requestId"`
	// Gets or sets error.
	Error ApiError `json:"error"`
}

ApiErrorResponse - ApiError Response

type BarcodeImageFormat

type BarcodeImageFormat string

BarcodeImageFormat : Specifies the file format of the image.

const (
	BarcodeImageFormatPng  BarcodeImageFormat = "Png"
	BarcodeImageFormatJpeg BarcodeImageFormat = "Jpeg"
	BarcodeImageFormatSvg  BarcodeImageFormat = "Svg"
	BarcodeImageFormatTiff BarcodeImageFormat = "Tiff"
	BarcodeImageFormatGif  BarcodeImageFormat = "Gif"
)

List of BarcodeImageFormat

type BarcodeImageParams

type BarcodeImageParams struct {
	// Barcode output image format. Default value: png.
	ImageFormat BarcodeImageFormat `json:"imageFormat,omitempty"`
	// Specify the displayed text location. Set to CodeLocation.None to hide CodeText. Default value depends on BarcodeType: CodeLocation.Below for 1D barcodes and CodeLocation.None for 2D barcodes.
	TextLocation CodeLocation `json:"textLocation,omitempty"`
	// Specify the display color for bars and content. Value: Color name from https://reference.aspose.com/drawing/net/system.drawing/color/ or ARGB value starting with #. For example: AliceBlue or #FF000000. Default value: Black.
	ForegroundColor string `json:"foregroundColor,omitempty"`
	// Background color of the barcode image. Value: Color name from https://reference.aspose.com/drawing/net/system.drawing/color/ or ARGB value starting with #. For example: AliceBlue or #FF000000. Default value: White.
	BackgroundColor string `json:"backgroundColor,omitempty"`
	// Common units for all measurements. Default units: pixels.
	Units GraphicsUnit `json:"units,omitempty"`
	// Resolution of the barcode image. One value for both dimensions. Default value: 96 dpi. Decimal separator is a dot.
	Resolution float32 `json:"resolution,omitempty"`
	// Height of the barcode image in the specified units. Default units: pixels. Decimal separator is a dot.
	ImageHeight float32 `json:"imageHeight,omitempty"`
	// Width of the barcode image in the specified units. Default units: pixels. Decimal separator is a dot.
	ImageWidth float32 `json:"imageWidth,omitempty"`
	// Barcode image rotation angle, measured in degrees. For example, RotationAngle = 0 or RotationAngle = 360 means no rotation. If RotationAngle is not equal to 90, 180, 270, or 0, it may increase the difficulty for the scanner to read the image. Default value: 0.
	RotationAngle int32 `json:"rotationAngle,omitempty"`
}

BarcodeImageParams - Optional barcode image parameters.

type BarcodeResponse

type BarcodeResponse struct {
	// Barcode data.
	BarcodeValue string `json:"barcodeValue,omitempty"`
	// Type of the barcode.
	Type string `json:"type,omitempty"`
	// Region with the barcode.
	Region []RegionPoint `json:"region,omitempty"`
	// Checksum of the barcode.
	Checksum string `json:"checksum,omitempty"`
}

BarcodeResponse - Represents information about a barcode.

type BarcodeResponseList

type BarcodeResponseList struct {
	// List of barcodes that are present in the image.
	Barcodes []BarcodeResponse `json:"barcodes"`
}

BarcodeResponseList - Represents information about a barcode list.

type BasicAuth

type BasicAuth struct {
	UserName string `json:"userName,omitempty"`
	Password string `json:"password,omitempty"`
}

BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth

type Code128EncodeMode added in v4.2606.0

type Code128EncodeMode string

Code128EncodeMode : Code128 barcode encode mode. Mirrors https://reference.aspose.com/barcode/net/aspose.barcode.generation/code128encodemode/

const (
	Code128EncodeModeAuto   Code128EncodeMode = "Auto"
	Code128EncodeModeCodeA  Code128EncodeMode = "CodeA"
	Code128EncodeModeCodeB  Code128EncodeMode = "CodeB"
	Code128EncodeModeCodeAB Code128EncodeMode = "CodeAB"
	Code128EncodeModeCodeC  Code128EncodeMode = "CodeC"
	Code128EncodeModeCodeAC Code128EncodeMode = "CodeAC"
	Code128EncodeModeCodeBC Code128EncodeMode = "CodeBC"
)

List of Code128EncodeMode

type Code128Params added in v4.2606.0

type Code128Params struct {
	// Code128 barcode encode mode. Controls which Code 128 subset (A, B, C, or mix) is used.
	Code128EncodeMode Code128EncodeMode `json:"code128EncodeMode,omitempty"`
}

Code128Params - Optional Code128 barcode generation parameters.

type CodeLocation

type CodeLocation string
const (
	CodeLocationBelow CodeLocation = "Below"
	CodeLocationAbove CodeLocation = "Above"
	CodeLocationNone  CodeLocation = "None"
)

List of CodeLocation

type Configuration

type Configuration struct {
	BasePath      string            `json:"basePath,omitempty"`
	Host          string            `json:"host,omitempty"`
	DefaultHeader map[string]string `json:"defaultHeader,omitempty"`
	UserAgent     string            `json:"userAgent,omitempty"`
	HTTPClient    *http.Client      `json:"-"`
}

Configuration - API configuration

func NewConfiguration

func NewConfiguration() *Configuration

NewConfiguration - constructor

func (*Configuration) AddDefaultHeader

func (c *Configuration) AddDefaultHeader(key string, value string)

AddDefaultHeader allow to add custom header

type DecodeBarcodeType

type DecodeBarcodeType string

DecodeBarcodeType : See https://reference.aspose.com/barcode/net/aspose.barcode.barcoderecognition/decodetype/

const (
	DecodeBarcodeTypeMostCommonlyUsed              DecodeBarcodeType = "MostCommonlyUsed"
	DecodeBarcodeTypeQR                            DecodeBarcodeType = "QR"
	DecodeBarcodeTypeAustraliaPost                 DecodeBarcodeType = "AustraliaPost"
	DecodeBarcodeTypeAustralianPosteParcel         DecodeBarcodeType = "AustralianPosteParcel"
	DecodeBarcodeTypeAztec                         DecodeBarcodeType = "Aztec"
	DecodeBarcodeTypeCodabar                       DecodeBarcodeType = "Codabar"
	DecodeBarcodeTypeCodablockF                    DecodeBarcodeType = "CodablockF"
	DecodeBarcodeTypeCode11                        DecodeBarcodeType = "Code11"
	DecodeBarcodeTypeCode128                       DecodeBarcodeType = "Code128"
	DecodeBarcodeTypeCode16K                       DecodeBarcodeType = "Code16K"
	DecodeBarcodeTypeCode32                        DecodeBarcodeType = "Code32"
	DecodeBarcodeTypeCode39                        DecodeBarcodeType = "Code39"
	DecodeBarcodeTypeCode39FullASCII               DecodeBarcodeType = "Code39FullASCII"
	DecodeBarcodeTypeCode93                        DecodeBarcodeType = "Code93"
	DecodeBarcodeTypeCompactPdf417                 DecodeBarcodeType = "CompactPdf417"
	DecodeBarcodeTypeDataLogic2of5                 DecodeBarcodeType = "DataLogic2of5"
	DecodeBarcodeTypeDataMatrix                    DecodeBarcodeType = "DataMatrix"
	DecodeBarcodeTypeDatabarExpanded               DecodeBarcodeType = "DatabarExpanded"
	DecodeBarcodeTypeDatabarExpandedStacked        DecodeBarcodeType = "DatabarExpandedStacked"
	DecodeBarcodeTypeDatabarLimited                DecodeBarcodeType = "DatabarLimited"
	DecodeBarcodeTypeDatabarOmniDirectional        DecodeBarcodeType = "DatabarOmniDirectional"
	DecodeBarcodeTypeDatabarStacked                DecodeBarcodeType = "DatabarStacked"
	DecodeBarcodeTypeDatabarStackedOmniDirectional DecodeBarcodeType = "DatabarStackedOmniDirectional"
	DecodeBarcodeTypeDatabarTruncated              DecodeBarcodeType = "DatabarTruncated"
	DecodeBarcodeTypeDeutschePostIdentcode         DecodeBarcodeType = "DeutschePostIdentcode"
	DecodeBarcodeTypeDeutschePostLeitcode          DecodeBarcodeType = "DeutschePostLeitcode"
	DecodeBarcodeTypeDotCode                       DecodeBarcodeType = "DotCode"
	DecodeBarcodeTypeDutchKIX                      DecodeBarcodeType = "DutchKIX"
	DecodeBarcodeTypeEAN13                         DecodeBarcodeType = "EAN13"
	DecodeBarcodeTypeEAN14                         DecodeBarcodeType = "EAN14"
	DecodeBarcodeTypeEAN8                          DecodeBarcodeType = "EAN8"
	DecodeBarcodeTypeGS1Aztec                      DecodeBarcodeType = "GS1Aztec"
	DecodeBarcodeTypeGS1Code128                    DecodeBarcodeType = "GS1Code128"
	DecodeBarcodeTypeGS1CompositeBar               DecodeBarcodeType = "GS1CompositeBar"
	DecodeBarcodeTypeGS1DataMatrix                 DecodeBarcodeType = "GS1DataMatrix"
	DecodeBarcodeTypeGS1DotCode                    DecodeBarcodeType = "GS1DotCode"
	DecodeBarcodeTypeGS1HanXin                     DecodeBarcodeType = "GS1HanXin"
	DecodeBarcodeTypeGS1MicroPdf417                DecodeBarcodeType = "GS1MicroPdf417"
	DecodeBarcodeTypeGS1QR                         DecodeBarcodeType = "GS1QR"
	DecodeBarcodeTypeHanXin                        DecodeBarcodeType = "HanXin"
	DecodeBarcodeTypeHIBCAztecLIC                  DecodeBarcodeType = "HIBCAztecLIC"
	DecodeBarcodeTypeHIBCAztecPAS                  DecodeBarcodeType = "HIBCAztecPAS"
	DecodeBarcodeTypeHIBCCode128LIC                DecodeBarcodeType = "HIBCCode128LIC"
	DecodeBarcodeTypeHIBCCode128PAS                DecodeBarcodeType = "HIBCCode128PAS"
	DecodeBarcodeTypeHIBCCode39LIC                 DecodeBarcodeType = "HIBCCode39LIC"
	DecodeBarcodeTypeHIBCCode39PAS                 DecodeBarcodeType = "HIBCCode39PAS"
	DecodeBarcodeTypeHIBCDataMatrixLIC             DecodeBarcodeType = "HIBCDataMatrixLIC"
	DecodeBarcodeTypeHIBCDataMatrixPAS             DecodeBarcodeType = "HIBCDataMatrixPAS"
	DecodeBarcodeTypeHIBCQRLIC                     DecodeBarcodeType = "HIBCQRLIC"
	DecodeBarcodeTypeHIBCQRPAS                     DecodeBarcodeType = "HIBCQRPAS"
	DecodeBarcodeTypeIATA2of5                      DecodeBarcodeType = "IATA2of5"
	DecodeBarcodeTypeISBN                          DecodeBarcodeType = "ISBN"
	DecodeBarcodeTypeISMN                          DecodeBarcodeType = "ISMN"
	DecodeBarcodeTypeISSN                          DecodeBarcodeType = "ISSN"
	DecodeBarcodeTypeITF14                         DecodeBarcodeType = "ITF14"
	DecodeBarcodeTypeITF6                          DecodeBarcodeType = "ITF6"
	DecodeBarcodeTypeInterleaved2of5               DecodeBarcodeType = "Interleaved2of5"
	DecodeBarcodeTypeItalianPost25                 DecodeBarcodeType = "ItalianPost25"
	DecodeBarcodeTypeMacroPdf417                   DecodeBarcodeType = "MacroPdf417"
	DecodeBarcodeTypeMailmark                      DecodeBarcodeType = "Mailmark"
	DecodeBarcodeTypeMatrix2of5                    DecodeBarcodeType = "Matrix2of5"
	DecodeBarcodeTypeMaxiCode                      DecodeBarcodeType = "MaxiCode"
	DecodeBarcodeTypeMicrE13B                      DecodeBarcodeType = "MicrE13B"
	DecodeBarcodeTypeMicroPdf417                   DecodeBarcodeType = "MicroPdf417"
	DecodeBarcodeTypeMicroQR                       DecodeBarcodeType = "MicroQR"
	DecodeBarcodeTypeMSI                           DecodeBarcodeType = "MSI"
	DecodeBarcodeTypeOneCode                       DecodeBarcodeType = "OneCode"
	DecodeBarcodeTypeOPC                           DecodeBarcodeType = "OPC"
	DecodeBarcodeTypePatchCode                     DecodeBarcodeType = "PatchCode"
	DecodeBarcodeTypePdf417                        DecodeBarcodeType = "Pdf417"
	DecodeBarcodeTypePharmacode                    DecodeBarcodeType = "Pharmacode"
	DecodeBarcodeTypePlanet                        DecodeBarcodeType = "Planet"
	DecodeBarcodeTypePostnet                       DecodeBarcodeType = "Postnet"
	DecodeBarcodeTypePZN                           DecodeBarcodeType = "PZN"
	DecodeBarcodeTypeRectMicroQR                   DecodeBarcodeType = "RectMicroQR"
	DecodeBarcodeTypeRM4SCC                        DecodeBarcodeType = "RM4SCC"
	DecodeBarcodeTypeSCC14                         DecodeBarcodeType = "SCC14"
	DecodeBarcodeTypeSSCC18                        DecodeBarcodeType = "SSCC18"
	DecodeBarcodeTypeStandard2of5                  DecodeBarcodeType = "Standard2of5"
	DecodeBarcodeTypeSupplement                    DecodeBarcodeType = "Supplement"
	DecodeBarcodeTypeSwissPostParcel               DecodeBarcodeType = "SwissPostParcel"
	DecodeBarcodeTypeUPCA                          DecodeBarcodeType = "UPCA"
	DecodeBarcodeTypeUPCE                          DecodeBarcodeType = "UPCE"
	DecodeBarcodeTypeVIN                           DecodeBarcodeType = "VIN"
)

List of DecodeBarcodeType

type ECIEncodings added in v4.2606.0

type ECIEncodings string

ECIEncodings : ECI encoding identifiers. Mirrors https://reference.aspose.com/barcode/net/aspose.barcode.generation/eciencodings/

const (
	ECIEncodingsNONE        ECIEncodings = "NONE"
	ECIEncodingsISO_8859_1  ECIEncodings = "ISO_8859_1"
	ECIEncodingsISO_8859_2  ECIEncodings = "ISO_8859_2"
	ECIEncodingsISO_8859_3  ECIEncodings = "ISO_8859_3"
	ECIEncodingsISO_8859_4  ECIEncodings = "ISO_8859_4"
	ECIEncodingsISO_8859_5  ECIEncodings = "ISO_8859_5"
	ECIEncodingsISO_8859_6  ECIEncodings = "ISO_8859_6"
	ECIEncodingsISO_8859_7  ECIEncodings = "ISO_8859_7"
	ECIEncodingsISO_8859_8  ECIEncodings = "ISO_8859_8"
	ECIEncodingsISO_8859_9  ECIEncodings = "ISO_8859_9"
	ECIEncodingsISO_8859_10 ECIEncodings = "ISO_8859_10"
	ECIEncodingsISO_8859_11 ECIEncodings = "ISO_8859_11"
	ECIEncodingsISO_8859_13 ECIEncodings = "ISO_8859_13"
	ECIEncodingsISO_8859_14 ECIEncodings = "ISO_8859_14"
	ECIEncodingsISO_8859_15 ECIEncodings = "ISO_8859_15"
	ECIEncodingsISO_8859_16 ECIEncodings = "ISO_8859_16"
	ECIEncodingsShift_JIS   ECIEncodings = "Shift_JIS"
	ECIEncodingsWin1250     ECIEncodings = "Win1250"
	ECIEncodingsWin1251     ECIEncodings = "Win1251"
	ECIEncodingsWin1252     ECIEncodings = "Win1252"
	ECIEncodingsWin1256     ECIEncodings = "Win1256"
	ECIEncodingsUTF16BE     ECIEncodings = "UTF16BE"
	ECIEncodingsUTF8        ECIEncodings = "UTF8"
	ECIEncodingsUS_ASCII    ECIEncodings = "US_ASCII"
	ECIEncodingsBig5        ECIEncodings = "Big5"
	ECIEncodingsGB2312      ECIEncodings = "GB2312"
	ECIEncodingsEUC_KR      ECIEncodings = "EUC_KR"
	ECIEncodingsGBK         ECIEncodings = "GBK"
	ECIEncodingsGB18030     ECIEncodings = "GB18030"
	ECIEncodingsUTF16LE     ECIEncodings = "UTF16LE"
	ECIEncodingsUTF32BE     ECIEncodings = "UTF32BE"
	ECIEncodingsUTF32LE     ECIEncodings = "UTF32LE"
	ECIEncodingsINVARIANT   ECIEncodings = "INVARIANT"
	ECIEncodingsBINARY      ECIEncodings = "BINARY"
)

List of ECIEncodings

type EncodeBarcodeType

type EncodeBarcodeType string

EncodeBarcodeType : See https://reference.aspose.com/barcode/net/aspose.barcode.generation/encodetypes/

const (
	EncodeBarcodeTypeQR                            EncodeBarcodeType = "QR"
	EncodeBarcodeTypeAustraliaPost                 EncodeBarcodeType = "AustraliaPost"
	EncodeBarcodeTypeAustralianPosteParcel         EncodeBarcodeType = "AustralianPosteParcel"
	EncodeBarcodeTypeAztec                         EncodeBarcodeType = "Aztec"
	EncodeBarcodeTypeCodabar                       EncodeBarcodeType = "Codabar"
	EncodeBarcodeTypeCodablockF                    EncodeBarcodeType = "CodablockF"
	EncodeBarcodeTypeCode11                        EncodeBarcodeType = "Code11"
	EncodeBarcodeTypeCode128                       EncodeBarcodeType = "Code128"
	EncodeBarcodeTypeCode16K                       EncodeBarcodeType = "Code16K"
	EncodeBarcodeTypeCode32                        EncodeBarcodeType = "Code32"
	EncodeBarcodeTypeCode39                        EncodeBarcodeType = "Code39"
	EncodeBarcodeTypeCode39FullASCII               EncodeBarcodeType = "Code39FullASCII"
	EncodeBarcodeTypeCode93                        EncodeBarcodeType = "Code93"
	EncodeBarcodeTypeDataLogic2of5                 EncodeBarcodeType = "DataLogic2of5"
	EncodeBarcodeTypeDataMatrix                    EncodeBarcodeType = "DataMatrix"
	EncodeBarcodeTypeDatabarExpanded               EncodeBarcodeType = "DatabarExpanded"
	EncodeBarcodeTypeDatabarExpandedStacked        EncodeBarcodeType = "DatabarExpandedStacked"
	EncodeBarcodeTypeDatabarLimited                EncodeBarcodeType = "DatabarLimited"
	EncodeBarcodeTypeDatabarOmniDirectional        EncodeBarcodeType = "DatabarOmniDirectional"
	EncodeBarcodeTypeDatabarStacked                EncodeBarcodeType = "DatabarStacked"
	EncodeBarcodeTypeDatabarStackedOmniDirectional EncodeBarcodeType = "DatabarStackedOmniDirectional"
	EncodeBarcodeTypeDatabarTruncated              EncodeBarcodeType = "DatabarTruncated"
	EncodeBarcodeTypeDeutschePostIdentcode         EncodeBarcodeType = "DeutschePostIdentcode"
	EncodeBarcodeTypeDeutschePostLeitcode          EncodeBarcodeType = "DeutschePostLeitcode"
	EncodeBarcodeTypeDotCode                       EncodeBarcodeType = "DotCode"
	EncodeBarcodeTypeDutchKIX                      EncodeBarcodeType = "DutchKIX"
	EncodeBarcodeTypeEAN13                         EncodeBarcodeType = "EAN13"
	EncodeBarcodeTypeEAN14                         EncodeBarcodeType = "EAN14"
	EncodeBarcodeTypeEAN8                          EncodeBarcodeType = "EAN8"
	EncodeBarcodeTypeGS1Aztec                      EncodeBarcodeType = "GS1Aztec"
	EncodeBarcodeTypeGS1CodablockF                 EncodeBarcodeType = "GS1CodablockF"
	EncodeBarcodeTypeGS1Code128                    EncodeBarcodeType = "GS1Code128"
	EncodeBarcodeTypeGS1DataMatrix                 EncodeBarcodeType = "GS1DataMatrix"
	EncodeBarcodeTypeGS1DotCode                    EncodeBarcodeType = "GS1DotCode"
	EncodeBarcodeTypeGS1HanXin                     EncodeBarcodeType = "GS1HanXin"
	EncodeBarcodeTypeGS1MicroPdf417                EncodeBarcodeType = "GS1MicroPdf417"
	EncodeBarcodeTypeGS1QR                         EncodeBarcodeType = "GS1QR"
	EncodeBarcodeTypeHanXin                        EncodeBarcodeType = "HanXin"
	EncodeBarcodeTypeIATA2of5                      EncodeBarcodeType = "IATA2of5"
	EncodeBarcodeTypeISBN                          EncodeBarcodeType = "ISBN"
	EncodeBarcodeTypeISMN                          EncodeBarcodeType = "ISMN"
	EncodeBarcodeTypeISSN                          EncodeBarcodeType = "ISSN"
	EncodeBarcodeTypeITF14                         EncodeBarcodeType = "ITF14"
	EncodeBarcodeTypeITF6                          EncodeBarcodeType = "ITF6"
	EncodeBarcodeTypeInterleaved2of5               EncodeBarcodeType = "Interleaved2of5"
	EncodeBarcodeTypeItalianPost25                 EncodeBarcodeType = "ItalianPost25"
	EncodeBarcodeTypeMSI                           EncodeBarcodeType = "MSI"
	EncodeBarcodeTypeMacroPdf417                   EncodeBarcodeType = "MacroPdf417"
	EncodeBarcodeTypeMailmark                      EncodeBarcodeType = "Mailmark"
	EncodeBarcodeTypeMatrix2of5                    EncodeBarcodeType = "Matrix2of5"
	EncodeBarcodeTypeMaxiCode                      EncodeBarcodeType = "MaxiCode"
	EncodeBarcodeTypeMicroPdf417                   EncodeBarcodeType = "MicroPdf417"
	EncodeBarcodeTypeMicroQR                       EncodeBarcodeType = "MicroQR"
	EncodeBarcodeTypeOPC                           EncodeBarcodeType = "OPC"
	EncodeBarcodeTypeOneCode                       EncodeBarcodeType = "OneCode"
	EncodeBarcodeTypePZN                           EncodeBarcodeType = "PZN"
	EncodeBarcodeTypePatchCode                     EncodeBarcodeType = "PatchCode"
	EncodeBarcodeTypePdf417                        EncodeBarcodeType = "Pdf417"
	EncodeBarcodeTypePharmacode                    EncodeBarcodeType = "Pharmacode"
	EncodeBarcodeTypePlanet                        EncodeBarcodeType = "Planet"
	EncodeBarcodeTypePostnet                       EncodeBarcodeType = "Postnet"
	EncodeBarcodeTypeRM4SCC                        EncodeBarcodeType = "RM4SCC"
	EncodeBarcodeTypeRectMicroQR                   EncodeBarcodeType = "RectMicroQR"
	EncodeBarcodeTypeSCC14                         EncodeBarcodeType = "SCC14"
	EncodeBarcodeTypeSSCC18                        EncodeBarcodeType = "SSCC18"
	EncodeBarcodeTypeSingaporePost                 EncodeBarcodeType = "SingaporePost"
	EncodeBarcodeTypeStandard2of5                  EncodeBarcodeType = "Standard2of5"
	EncodeBarcodeTypeSwissPostParcel               EncodeBarcodeType = "SwissPostParcel"
	EncodeBarcodeTypeUPCA                          EncodeBarcodeType = "UPCA"
	EncodeBarcodeTypeUPCE                          EncodeBarcodeType = "UPCE"
	EncodeBarcodeTypeUpcaGs1Code128Coupon          EncodeBarcodeType = "UpcaGs1Code128Coupon"
	EncodeBarcodeTypeUpcaGs1DatabarCoupon          EncodeBarcodeType = "UpcaGs1DatabarCoupon"
	EncodeBarcodeTypeVIN                           EncodeBarcodeType = "VIN"
)

List of EncodeBarcodeType

type EncodeData

type EncodeData struct {
	// Type of data to encode. Default value: StringData.
	DataType EncodeDataType `json:"dataType,omitempty"`
	// String that represents the data to encode.
	Data string `json:"data"`
}

EncodeData - Data to encode in a barcode.

type EncodeDataType

type EncodeDataType string

EncodeDataType : Types of data that can be encoded into a barcode.

const (
	EncodeDataTypeStringData  EncodeDataType = "StringData"
	EncodeDataTypeBase64Bytes EncodeDataType = "Base64Bytes"
	EncodeDataTypeHexBytes    EncodeDataType = "HexBytes"
)

List of EncodeDataType

type GenerateAPIGenerateMultipartOpts

type GenerateAPIGenerateMultipartOpts struct {
	DataType           optional.Interface
	BarcodeImageParams optional.Interface
	QrParams           optional.Interface
	Code128Params      optional.Interface
	Pdf417Params       optional.Interface
}

GenerateAPIGenerateMultipartOpts - Optional Parameters for GenerateAPIGenerateMultipart

type GenerateAPIGenerateOpts

type GenerateAPIGenerateOpts struct {
	DataType           optional.Interface
	BarcodeImageParams optional.Interface
	QrParams           optional.Interface
	Code128Params      optional.Interface
	Pdf417Params       optional.Interface
}

GenerateAPIGenerateOpts - Optional Parameters for GenerateAPIGenerate

type GenerateAPIService

type GenerateAPIService service

GenerateAPIService -

func (*GenerateAPIService) Generate

func (a *GenerateAPIService) Generate(ctx context.Context, barcodeType EncodeBarcodeType, data string, optionals *GenerateAPIGenerateOpts) ([]byte, *http.Response, error)

* Generate - Generate a barcode using a GET request with parameters in the route and query string. * @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @param barcodeType Type of barcode to generate. * @param data String that represents the data to encode. * @param optional nil or *GenerateAPIGenerateOpts - Optional Parameters:

  • @param "DataType" (optional.Interface of EncodeDataType) - Type of data to encode. Default value: StringData.
  • @param "ImageFormat" (optional.Interface of BarcodeImageFormat) - Barcode output image format. Default value: png.
  • @param "TextLocation" (optional.Interface of CodeLocation) - Specify the displayed text location. Set to CodeLocation.None to hide CodeText. Default value depends on BarcodeType: CodeLocation.Below for 1D barcodes and CodeLocation.None for 2D barcodes.
  • @param "ForegroundColor" (optional.String) - Specify the display color for bars and content. Value: Color name from https://reference.aspose.com/drawing/net/system.drawing/color/ or ARGB value starting with #. For example: AliceBlue or #FF000000. Default value: Black.
  • @param "BackgroundColor" (optional.String) - Background color of the barcode image. Value: Color name from https://reference.aspose.com/drawing/net/system.drawing/color/ or ARGB value starting with #. For example: AliceBlue or #FF000000. Default value: White.
  • @param "Units" (optional.Interface of GraphicsUnit) - Common units for all measurements. Default units: pixels.
  • @param "Resolution" (optional.Float32) - Resolution of the barcode image. One value for both dimensions. Default value: 96 dpi. Decimal separator is a dot.
  • @param "ImageHeight" (optional.Float32) - Height of the barcode image in the specified units. Default units: pixels. Decimal separator is a dot.
  • @param "ImageWidth" (optional.Float32) - Width of the barcode image in the specified units. Default units: pixels. Decimal separator is a dot.
  • @param "RotationAngle" (optional.Int32) - Barcode image rotation angle, measured in degrees. For example, RotationAngle = 0 or RotationAngle = 360 means no rotation. If RotationAngle is not equal to 90, 180, 270, or 0, it may increase the difficulty for the scanner to read the image. Default value: 0.
  • @param "QrEncodeMode" (optional.Interface of QREncodeMode) - QR barcode encode mode.
  • @param "QrErrorLevel" (optional.Interface of QRErrorLevel) - QR barcode error correction level.
  • @param "QrVersion" (optional.Interface of QRVersion) - QR barcode version. Automatically selects the smallest version that fits the data.
  • @param "QrECIEncoding" (optional.Interface of ECIEncodings) - ECI encoding for QR barcode data.
  • @param "QrAspectRatio" (optional.Float32) - QR barcode aspect ratio. Values: 0 to 1.
  • @param "MicroQRVersion" (optional.Interface of MicroQRVersion) - MicroQR barcode version. Used when BarcodeType is MicroQR.
  • @param "RectMicroQrVersion" (optional.Interface of RectMicroQRVersion) - RectMicroQR barcode version. Used when BarcodeType is RectMicroQR.
  • @param "Code128EncodeMode" (optional.Interface of Code128EncodeMode) - Code128 barcode encode mode. Controls which Code 128 subset (A, B, C, or mix) is used.
  • @param "Pdf417EncodeMode" (optional.Interface of Pdf417EncodeMode) - PDF417 barcode encode mode.
  • @param "Pdf417ErrorLevel" (optional.Interface of Pdf417ErrorLevel) - PDF417 barcode error correction level.
  • @param "Pdf417Truncate" (optional.Bool) - Whether to use truncated PDF417 format (removes right-side stop pattern).
  • @param "Pdf417Columns" (optional.Int32) - Number of columns in the PDF417 barcode. Values between 1 and 30. 0 for auto.
  • @param "Pdf417Rows" (optional.Int32) - Number of rows in the PDF417 barcode. Values between 3 and 90. 0 for automatic.
  • @param "Pdf417AspectRatio" (optional.Float32) - PDF417 barcode aspect ratio (height/width of the barcode module). Values are defined by the standard: 2 to 5 for MicroPdf417; 3 to 5 for Pdf417 and MacroPdf417.
  • @param "Pdf417ECIEncoding" (optional.Interface of ECIEncodings) - ECI encoding for PDF417 barcode data.
  • @param "Pdf417IsReaderInitialization" (optional.Bool) - Whether the barcode is used for reader initialization (programming).
  • @param "Pdf417MacroCharacters" (optional.Interface of MacroCharacter) - Macro character to prepend (structured append).
  • @param "Pdf417IsLinked" (optional.Bool) - Whether to use linked mode (for MicroPdf417).
  • @param "Pdf417IsCode128Emulation" (optional.Bool) - Whether to use Code128 emulation for MicroPdf417.

* @return []byte

func (*GenerateAPIService) GenerateBody

func (a *GenerateAPIService) GenerateBody(ctx context.Context, generateParams GenerateParams) ([]byte, *http.Response, error)

* GenerateBody - Generate a barcode using a POST request with parameters in the request body in JSON or XML format. * @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @param generateParams Generation parameters.

* @return []byte

func (*GenerateAPIService) GenerateMultipart

func (a *GenerateAPIService) GenerateMultipart(ctx context.Context, barcodeType EncodeBarcodeType, data string, optionals *GenerateAPIGenerateMultipartOpts) ([]byte, *http.Response, error)

* GenerateMultipart - Generate a barcode using a POST request with parameters in a multipart form. * @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @param barcodeType See https://reference.aspose.com/barcode/net/aspose.barcode.generation/encodetypes/ * @param data String that represents the data to encode. * @param optional nil or *GenerateAPIGenerateMultipartOpts - Optional Parameters:

  • @param "DataType" (optional.Interface of EncodeDataType) - Type of data to encode. Default value: StringData.
  • @param "ImageFormat" (optional.Interface of BarcodeImageFormat) - Barcode output image format. Default value: png.
  • @param "TextLocation" (optional.Interface of CodeLocation) - Specify the displayed text location. Set to CodeLocation.None to hide CodeText. Default value depends on BarcodeType: CodeLocation.Below for 1D barcodes and CodeLocation.None for 2D barcodes.
  • @param "ForegroundColor" (optional.String) - Specify the display color for bars and content. Value: Color name from https://reference.aspose.com/drawing/net/system.drawing/color/ or ARGB value starting with #. For example: AliceBlue or #FF000000. Default value: Black.
  • @param "BackgroundColor" (optional.String) - Background color of the barcode image. Value: Color name from https://reference.aspose.com/drawing/net/system.drawing/color/ or ARGB value starting with #. For example: AliceBlue or #FF000000. Default value: White.
  • @param "Units" (optional.Interface of GraphicsUnit) - Common units for all measurements. Default units: pixels.
  • @param "Resolution" (optional.Float32) - Resolution of the barcode image. One value for both dimensions. Default value: 96 dpi. Decimal separator is a dot.
  • @param "ImageHeight" (optional.Float32) - Height of the barcode image in the specified units. Default units: pixels. Decimal separator is a dot.
  • @param "ImageWidth" (optional.Float32) - Width of the barcode image in the specified units. Default units: pixels. Decimal separator is a dot.
  • @param "RotationAngle" (optional.Int32) - Barcode image rotation angle, measured in degrees. For example, RotationAngle = 0 or RotationAngle = 360 means no rotation. If RotationAngle is not equal to 90, 180, 270, or 0, it may increase the difficulty for the scanner to read the image. Default value: 0.
  • @param "QrEncodeMode" (optional.Interface of QREncodeMode) - QR barcode encode mode.
  • @param "QrErrorLevel" (optional.Interface of QRErrorLevel) - QR barcode error correction level.
  • @param "QrVersion" (optional.Interface of QRVersion) - QR barcode version. Automatically selects the smallest version that fits the data.
  • @param "QrECIEncoding" (optional.Interface of ECIEncodings) - ECI encoding for QR barcode data.
  • @param "QrAspectRatio" (optional.Float32) - QR barcode aspect ratio. Values: 0 to 1.
  • @param "MicroQRVersion" (optional.Interface of MicroQRVersion) - MicroQR barcode version. Used when BarcodeType is MicroQR.
  • @param "RectMicroQrVersion" (optional.Interface of RectMicroQRVersion) - RectMicroQR barcode version. Used when BarcodeType is RectMicroQR.
  • @param "Code128EncodeMode" (optional.Interface of Code128EncodeMode) - Code128 barcode encode mode. Controls which Code 128 subset (A, B, C, or mix) is used.
  • @param "Pdf417EncodeMode" (optional.Interface of Pdf417EncodeMode) - PDF417 barcode encode mode.
  • @param "Pdf417ErrorLevel" (optional.Interface of Pdf417ErrorLevel) - PDF417 barcode error correction level.
  • @param "Pdf417Truncate" (optional.Bool) - Whether to use truncated PDF417 format (removes right-side stop pattern).
  • @param "Pdf417Columns" (optional.Int32) - Number of columns in the PDF417 barcode. Values between 1 and 30. 0 for auto.
  • @param "Pdf417Rows" (optional.Int32) - Number of rows in the PDF417 barcode. Values between 3 and 90. 0 for automatic.
  • @param "Pdf417AspectRatio" (optional.Float32) - PDF417 barcode aspect ratio (height/width of the barcode module). Values are defined by the standard: 2 to 5 for MicroPdf417; 3 to 5 for Pdf417 and MacroPdf417.
  • @param "Pdf417ECIEncoding" (optional.Interface of ECIEncodings) - ECI encoding for PDF417 barcode data.
  • @param "Pdf417IsReaderInitialization" (optional.Bool) - Whether the barcode is used for reader initialization (programming).
  • @param "Pdf417MacroCharacters" (optional.Interface of MacroCharacter) - Macro character to prepend (structured append).
  • @param "Pdf417IsLinked" (optional.Bool) - Whether to use linked mode (for MicroPdf417).
  • @param "Pdf417IsCode128Emulation" (optional.Bool) - Whether to use Code128 emulation for MicroPdf417.

* @return []byte

type GenerateParams

type GenerateParams struct {
	// Barcode type.
	BarcodeType EncodeBarcodeType `json:"barcodeType"`
	// Data to encode into a barcode.
	EncodeData EncodeData `json:"encodeData"`
	// Optional barcode image parameters.
	BarcodeImageParams BarcodeImageParams `json:"barcodeImageParams,omitempty"`
	// Optional QR barcode generation parameters.
	QrParams QrParams `json:"qrParams,omitempty"`
	// Optional Code128 barcode generation parameters.
	Code128Params Code128Params `json:"code128Params,omitempty"`
	// Optional PDF417 barcode generation parameters.
	Pdf417Params Pdf417Params `json:"pdf417Params,omitempty"`
}

GenerateParams - Barcode generation parameters.

type GenericAPIError

type GenericAPIError struct {
	StatusCode int
	// contains filtered or unexported fields
}

GenericAPIError Provides access to the body, error and model on returned errors.

func (GenericAPIError) Error

func (e GenericAPIError) Error() string

Error returns non-empty string if there was an error.

func (GenericAPIError) Model

func (e GenericAPIError) Model() interface{}

Model returns the unpacked model of the error

func (GenericAPIError) Text

func (e GenericAPIError) Text() string

Text returns the text of the response

type GraphicsUnit

type GraphicsUnit string

GraphicsUnit : Subset of https://reference.aspose.com/drawing/net/system.drawing/graphicsunit/

const (
	GraphicsUnitPixel      GraphicsUnit = "Pixel"
	GraphicsUnitPoint      GraphicsUnit = "Point"
	GraphicsUnitInch       GraphicsUnit = "Inch"
	GraphicsUnitMillimeter GraphicsUnit = "Millimeter"
)

List of GraphicsUnit

type MacroCharacter added in v4.2606.0

type MacroCharacter string

MacroCharacter : PDF417 macro character mode. Mirrors https://reference.aspose.com/barcode/net/aspose.barcode.generation/macrocharacter/

const (
	MacroCharacterNone    MacroCharacter = "None"
	MacroCharacterMacro05 MacroCharacter = "Macro05"
	MacroCharacterMacro06 MacroCharacter = "Macro06"
)

List of MacroCharacter

type MappedNullable

type MappedNullable interface {
	ToMap() (map[string]interface{}, error)
}

type MicroQRVersion added in v4.2606.0

type MicroQRVersion string

MicroQRVersion : MicroQR barcode version. Mirrors https://reference.aspose.com/barcode/net/aspose.barcode.generation/microqrversion/

const (
	MicroQRVersionAuto MicroQRVersion = "Auto"
	MicroQRVersionM1   MicroQRVersion = "M1"
	MicroQRVersionM2   MicroQRVersion = "M2"
	MicroQRVersionM3   MicroQRVersion = "M3"
	MicroQRVersionM4   MicroQRVersion = "M4"
)

List of MicroQRVersion

type NullableBool

type NullableBool struct {
	// contains filtered or unexported fields
}

func NewNullableBool

func NewNullableBool(val *bool) *NullableBool

func (NullableBool) Get

func (v NullableBool) Get() *bool

func (NullableBool) IsSet

func (v NullableBool) IsSet() bool

func (NullableBool) MarshalJSON

func (v NullableBool) MarshalJSON() ([]byte, error)

func (*NullableBool) Set

func (v *NullableBool) Set(val *bool)

func (*NullableBool) UnmarshalJSON

func (v *NullableBool) UnmarshalJSON(src []byte) error

func (*NullableBool) Unset

func (v *NullableBool) Unset()

type NullableFloat32

type NullableFloat32 struct {
	// contains filtered or unexported fields
}

func NewNullableFloat32

func NewNullableFloat32(val *float32) *NullableFloat32

func (NullableFloat32) Get

func (v NullableFloat32) Get() *float32

func (NullableFloat32) IsSet

func (v NullableFloat32) IsSet() bool

func (NullableFloat32) MarshalJSON

func (v NullableFloat32) MarshalJSON() ([]byte, error)

func (*NullableFloat32) Set

func (v *NullableFloat32) Set(val *float32)

func (*NullableFloat32) UnmarshalJSON

func (v *NullableFloat32) UnmarshalJSON(src []byte) error

func (*NullableFloat32) Unset

func (v *NullableFloat32) Unset()

type NullableFloat64

type NullableFloat64 struct {
	// contains filtered or unexported fields
}

func NewNullableFloat64

func NewNullableFloat64(val *float64) *NullableFloat64

func (NullableFloat64) Get

func (v NullableFloat64) Get() *float64

func (NullableFloat64) IsSet

func (v NullableFloat64) IsSet() bool

func (NullableFloat64) MarshalJSON

func (v NullableFloat64) MarshalJSON() ([]byte, error)

func (*NullableFloat64) Set

func (v *NullableFloat64) Set(val *float64)

func (*NullableFloat64) UnmarshalJSON

func (v *NullableFloat64) UnmarshalJSON(src []byte) error

func (*NullableFloat64) Unset

func (v *NullableFloat64) Unset()

type NullableInt

type NullableInt struct {
	// contains filtered or unexported fields
}

func NewNullableInt

func NewNullableInt(val *int) *NullableInt

func (NullableInt) Get

func (v NullableInt) Get() *int

func (NullableInt) IsSet

func (v NullableInt) IsSet() bool

func (NullableInt) MarshalJSON

func (v NullableInt) MarshalJSON() ([]byte, error)

func (*NullableInt) Set

func (v *NullableInt) Set(val *int)

func (*NullableInt) UnmarshalJSON

func (v *NullableInt) UnmarshalJSON(src []byte) error

func (*NullableInt) Unset

func (v *NullableInt) Unset()

type NullableInt32

type NullableInt32 struct {
	// contains filtered or unexported fields
}

func NewNullableInt32

func NewNullableInt32(val *int32) *NullableInt32

func (NullableInt32) Get

func (v NullableInt32) Get() *int32

func (NullableInt32) IsSet

func (v NullableInt32) IsSet() bool

func (NullableInt32) MarshalJSON

func (v NullableInt32) MarshalJSON() ([]byte, error)

func (*NullableInt32) Set

func (v *NullableInt32) Set(val *int32)

func (*NullableInt32) UnmarshalJSON

func (v *NullableInt32) UnmarshalJSON(src []byte) error

func (*NullableInt32) Unset

func (v *NullableInt32) Unset()

type NullableInt64

type NullableInt64 struct {
	// contains filtered or unexported fields
}

func NewNullableInt64

func NewNullableInt64(val *int64) *NullableInt64

func (NullableInt64) Get

func (v NullableInt64) Get() *int64

func (NullableInt64) IsSet

func (v NullableInt64) IsSet() bool

func (NullableInt64) MarshalJSON

func (v NullableInt64) MarshalJSON() ([]byte, error)

func (*NullableInt64) Set

func (v *NullableInt64) Set(val *int64)

func (*NullableInt64) UnmarshalJSON

func (v *NullableInt64) UnmarshalJSON(src []byte) error

func (*NullableInt64) Unset

func (v *NullableInt64) Unset()

type NullableString

type NullableString struct {
	// contains filtered or unexported fields
}

func NewNullableString

func NewNullableString(val *string) *NullableString

func (NullableString) Get

func (v NullableString) Get() *string

func (NullableString) IsSet

func (v NullableString) IsSet() bool

func (NullableString) MarshalJSON

func (v NullableString) MarshalJSON() ([]byte, error)

func (*NullableString) Set

func (v *NullableString) Set(val *string)

func (*NullableString) UnmarshalJSON

func (v *NullableString) UnmarshalJSON(src []byte) error

func (*NullableString) Unset

func (v *NullableString) Unset()

type NullableTime

type NullableTime struct {
	// contains filtered or unexported fields
}

func NewNullableTime

func NewNullableTime(val *time.Time) *NullableTime

func (NullableTime) Get

func (v NullableTime) Get() *time.Time

func (NullableTime) IsSet

func (v NullableTime) IsSet() bool

func (NullableTime) MarshalJSON

func (v NullableTime) MarshalJSON() ([]byte, error)

func (*NullableTime) Set

func (v *NullableTime) Set(val *time.Time)

func (*NullableTime) UnmarshalJSON

func (v *NullableTime) UnmarshalJSON(src []byte) error

func (*NullableTime) Unset

func (v *NullableTime) Unset()

type Pdf417EncodeMode added in v4.2606.0

type Pdf417EncodeMode string

Pdf417EncodeMode : PDF417 barcode encode mode. Mirrors https://reference.aspose.com/barcode/net/aspose.barcode.generation/pdf417encodemode/

const (
	Pdf417EncodeModeAuto     Pdf417EncodeMode = "Auto"
	Pdf417EncodeModeBinary   Pdf417EncodeMode = "Binary"
	Pdf417EncodeModeECI      Pdf417EncodeMode = "ECI"
	Pdf417EncodeModeExtended Pdf417EncodeMode = "Extended"
)

List of Pdf417EncodeMode

type Pdf417ErrorLevel added in v4.2606.0

type Pdf417ErrorLevel string

Pdf417ErrorLevel : PDF417 barcode error correction level. Mirrors https://reference.aspose.com/barcode/net/aspose.barcode.generation/pdf417errorlevel/

const (
	Pdf417ErrorLevelLevel0 Pdf417ErrorLevel = "Level0"
	Pdf417ErrorLevelLevel1 Pdf417ErrorLevel = "Level1"
	Pdf417ErrorLevelLevel2 Pdf417ErrorLevel = "Level2"
	Pdf417ErrorLevelLevel3 Pdf417ErrorLevel = "Level3"
	Pdf417ErrorLevelLevel4 Pdf417ErrorLevel = "Level4"
	Pdf417ErrorLevelLevel5 Pdf417ErrorLevel = "Level5"
	Pdf417ErrorLevelLevel6 Pdf417ErrorLevel = "Level6"
	Pdf417ErrorLevelLevel7 Pdf417ErrorLevel = "Level7"
	Pdf417ErrorLevelLevel8 Pdf417ErrorLevel = "Level8"
)

List of Pdf417ErrorLevel

type Pdf417Params added in v4.2606.0

type Pdf417Params struct {
	// PDF417 barcode encode mode.
	Pdf417EncodeMode Pdf417EncodeMode `json:"pdf417EncodeMode,omitempty"`
	// PDF417 barcode error correction level.
	Pdf417ErrorLevel Pdf417ErrorLevel `json:"pdf417ErrorLevel,omitempty"`
	// Whether to use truncated PDF417 format (removes right-side stop pattern).
	Pdf417Truncate bool `json:"pdf417Truncate,omitempty"`
	// Number of columns in the PDF417 barcode. Values between 1 and 30. 0 for auto.
	Pdf417Columns int32 `json:"pdf417Columns,omitempty"`
	// Number of rows in the PDF417 barcode. Values between 3 and 90. 0 for automatic.
	Pdf417Rows int32 `json:"pdf417Rows,omitempty"`
	// PDF417 barcode aspect ratio (height/width of the barcode module). Values are defined by the standard: 2 to 5 for MicroPdf417; 3 to 5 for Pdf417 and MacroPdf417.
	Pdf417AspectRatio float32 `json:"pdf417AspectRatio,omitempty"`
	// ECI encoding for PDF417 barcode data.
	Pdf417ECIEncoding ECIEncodings `json:"pdf417ECIEncoding,omitempty"`
	// Whether the barcode is used for reader initialization (programming).
	Pdf417IsReaderInitialization bool `json:"pdf417IsReaderInitialization,omitempty"`
	// Macro character to prepend (structured append).
	Pdf417MacroCharacters MacroCharacter `json:"pdf417MacroCharacters,omitempty"`
	// Whether to use linked mode (for MicroPdf417).
	Pdf417IsLinked bool `json:"pdf417IsLinked,omitempty"`
	// Whether to use Code128 emulation for MicroPdf417.
	Pdf417IsCode128Emulation bool `json:"pdf417IsCode128Emulation,omitempty"`
}

Pdf417Params - Optional PDF417 barcode generation parameters. Applies to Pdf417, MacroPdf417, MicroPdf417, and GS1MicroPdf417 barcode types.

type QREncodeMode added in v4.2606.0

type QREncodeMode string

QREncodeMode : QR barcode encode mode. Subset of https://reference.aspose.com/barcode/net/aspose.barcode.generation/qrencodemode/ Obsolete members (Bytes, Utf8BOM, Utf16BEBOM, ECIEncoding, ExtendedCodetext) are omitted.

const (
	QREncodeModeAuto     QREncodeMode = "Auto"
	QREncodeModeExtended QREncodeMode = "Extended"
	QREncodeModeBinary   QREncodeMode = "Binary"
	QREncodeModeECI      QREncodeMode = "ECI"
)

List of QREncodeMode

type QRErrorLevel added in v4.2606.0

type QRErrorLevel string

QRErrorLevel : QR barcode error correction level. Mirrors https://reference.aspose.com/barcode/net/aspose.barcode.generation/qrerrorlevel/

const (
	QRErrorLevelLevelL QRErrorLevel = "LevelL"
	QRErrorLevelLevelM QRErrorLevel = "LevelM"
	QRErrorLevelLevelQ QRErrorLevel = "LevelQ"
	QRErrorLevelLevelH QRErrorLevel = "LevelH"
)

List of QRErrorLevel

type QRVersion added in v4.2606.0

type QRVersion string

QRVersion : QR barcode version. Subset of https://reference.aspose.com/barcode/net/aspose.barcode.generation/qrversion/ MicroQR versions (VersionM1–VersionM4) are omitted; use Aspose.BarCode.Cloud.DTO.Enums.MicroQRVersion instead.

const (
	QRVersionAuto      QRVersion = "Auto"
	QRVersionVersion01 QRVersion = "Version01"
	QRVersionVersion02 QRVersion = "Version02"
	QRVersionVersion03 QRVersion = "Version03"
	QRVersionVersion04 QRVersion = "Version04"
	QRVersionVersion05 QRVersion = "Version05"
	QRVersionVersion06 QRVersion = "Version06"
	QRVersionVersion07 QRVersion = "Version07"
	QRVersionVersion08 QRVersion = "Version08"
	QRVersionVersion09 QRVersion = "Version09"
	QRVersionVersion10 QRVersion = "Version10"
	QRVersionVersion11 QRVersion = "Version11"
	QRVersionVersion12 QRVersion = "Version12"
	QRVersionVersion13 QRVersion = "Version13"
	QRVersionVersion14 QRVersion = "Version14"
	QRVersionVersion15 QRVersion = "Version15"
	QRVersionVersion16 QRVersion = "Version16"
	QRVersionVersion17 QRVersion = "Version17"
	QRVersionVersion18 QRVersion = "Version18"
	QRVersionVersion19 QRVersion = "Version19"
	QRVersionVersion20 QRVersion = "Version20"
	QRVersionVersion21 QRVersion = "Version21"
	QRVersionVersion22 QRVersion = "Version22"
	QRVersionVersion23 QRVersion = "Version23"
	QRVersionVersion24 QRVersion = "Version24"
	QRVersionVersion25 QRVersion = "Version25"
	QRVersionVersion26 QRVersion = "Version26"
	QRVersionVersion27 QRVersion = "Version27"
	QRVersionVersion28 QRVersion = "Version28"
	QRVersionVersion29 QRVersion = "Version29"
	QRVersionVersion30 QRVersion = "Version30"
	QRVersionVersion31 QRVersion = "Version31"
	QRVersionVersion32 QRVersion = "Version32"
	QRVersionVersion33 QRVersion = "Version33"
	QRVersionVersion34 QRVersion = "Version34"
	QRVersionVersion35 QRVersion = "Version35"
	QRVersionVersion36 QRVersion = "Version36"
	QRVersionVersion37 QRVersion = "Version37"
	QRVersionVersion38 QRVersion = "Version38"
	QRVersionVersion39 QRVersion = "Version39"
	QRVersionVersion40 QRVersion = "Version40"
)

List of QRVersion

type QrParams added in v4.2606.0

type QrParams struct {
	// QR barcode encode mode.
	QrEncodeMode QREncodeMode `json:"qrEncodeMode,omitempty"`
	// QR barcode error correction level.
	QrErrorLevel QRErrorLevel `json:"qrErrorLevel,omitempty"`
	// QR barcode version. Automatically selects the smallest version that fits the data.
	QrVersion QRVersion `json:"qrVersion,omitempty"`
	// ECI encoding for QR barcode data.
	QrECIEncoding ECIEncodings `json:"qrECIEncoding,omitempty"`
	// QR barcode aspect ratio. Values: 0 to 1.
	QrAspectRatio float32 `json:"qrAspectRatio,omitempty"`
	// MicroQR barcode version. Used when BarcodeType is MicroQR.
	MicroQRVersion MicroQRVersion `json:"microQRVersion,omitempty"`
	// RectMicroQR barcode version. Used when BarcodeType is RectMicroQR.
	RectMicroQrVersion RectMicroQRVersion `json:"rectMicroQrVersion,omitempty"`
}

QrParams - Optional QR barcode generation parameters. Applies to QR, GS1QR, MicroQR, and RectMicroQR barcode types.

type RecognitionImageKind

type RecognitionImageKind string

RecognitionImageKind : Kind of image to recognize

const (
	RecognitionImageKindPhoto           RecognitionImageKind = "Photo"
	RecognitionImageKindScannedDocument RecognitionImageKind = "ScannedDocument"
	RecognitionImageKindClearImage      RecognitionImageKind = "ClearImage"
)

List of RecognitionImageKind

type RecognitionMode

type RecognitionMode string

RecognitionMode : Recognition mode.

const (
	RecognitionModeFast      RecognitionMode = "Fast"
	RecognitionModeNormal    RecognitionMode = "Normal"
	RecognitionModeExcellent RecognitionMode = "Excellent"
)

List of RecognitionMode

type RecognizeAPIRecognizeMultipartOpts

type RecognizeAPIRecognizeMultipartOpts struct {
	RecognitionMode      optional.Interface
	RecognitionImageKind optional.Interface
}

RecognizeAPIRecognizeMultipartOpts - Optional Parameters for RecognizeAPIRecognizeMultipart

type RecognizeAPIRecognizeOpts

type RecognizeAPIRecognizeOpts struct {
	RecognitionMode      optional.Interface
	RecognitionImageKind optional.Interface
}

RecognizeAPIRecognizeOpts - Optional Parameters for RecognizeAPIRecognize

type RecognizeAPIService

type RecognizeAPIService service

RecognizeAPIService -

func (*RecognizeAPIService) Recognize

* Recognize - Recognize a barcode from a file on an Internet server using a GET request with a query string parameter. For recognizing files from your hard drive, use `recognize-body` or `recognize-multipart` endpoints instead. * @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @param barcodeType Type of barcode to recognize. * @param fileUrl URL to the barcode image. * @param optional nil or *RecognizeAPIRecognizeOpts - Optional Parameters:

  • @param "RecognitionMode" (optional.Interface of RecognitionMode) - Recognition mode.
  • @param "RecognitionImageKind" (optional.Interface of RecognitionImageKind) - Image kind for recognition.

* @return BarcodeResponseList

func (*RecognizeAPIService) RecognizeBase64

func (a *RecognizeAPIService) RecognizeBase64(ctx context.Context, recognizeBase64Request RecognizeBase64Request) (BarcodeResponseList, *http.Response, error)

* RecognizeBase64 - Recognize a barcode from a file in the request body using a POST request with JSON or XML body parameters. * @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @param recognizeBase64Request Barcode recognition request.

* @return BarcodeResponseList

func (*RecognizeAPIService) RecognizeMultipart

* RecognizeMultipart - Recognize a barcode from a file in the request body using a POST request with multipart form parameters. * @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @param barcodeType See https://reference.aspose.com/barcode/net/aspose.barcode.barcoderecognition/decodetype/ * @param file Barcode image file. * @param optional nil or *RecognizeAPIRecognizeMultipartOpts - Optional Parameters:

  • @param "RecognitionMode" (optional.Interface of RecognitionMode) - Recognition mode.
  • @param "RecognitionImageKind" (optional.Interface of RecognitionImageKind) - Image kind for recognition.

* @return BarcodeResponseList

type RecognizeBase64Request

type RecognizeBase64Request struct {
	// Array of barcode decode types to find.
	BarcodeTypes []DecodeBarcodeType `json:"barcodeTypes"`
	// Barcode image bytes encoded as base-64.
	FileBase64 string `json:"fileBase64"`
	// Barcode recognition mode.
	RecognitionMode RecognitionMode `json:"recognitionMode,omitempty"`
	// Image kind for recognition.
	RecognitionImageKind RecognitionImageKind `json:"recognitionImageKind,omitempty"`
}

RecognizeBase64Request - Barcode recognition request.

type RectMicroQRVersion added in v4.2606.0

type RectMicroQRVersion string

RectMicroQRVersion : RectMicroQR barcode version. Mirrors https://reference.aspose.com/barcode/net/aspose.barcode.generation/rectmicroqrversion/

const (
	RectMicroQRVersionAuto    RectMicroQRVersion = "Auto"
	RectMicroQRVersionR7x43   RectMicroQRVersion = "R7x43"
	RectMicroQRVersionR7x59   RectMicroQRVersion = "R7x59"
	RectMicroQRVersionR7x77   RectMicroQRVersion = "R7x77"
	RectMicroQRVersionR7x99   RectMicroQRVersion = "R7x99"
	RectMicroQRVersionR7x139  RectMicroQRVersion = "R7x139"
	RectMicroQRVersionR9x43   RectMicroQRVersion = "R9x43"
	RectMicroQRVersionR9x59   RectMicroQRVersion = "R9x59"
	RectMicroQRVersionR9x77   RectMicroQRVersion = "R9x77"
	RectMicroQRVersionR9x99   RectMicroQRVersion = "R9x99"
	RectMicroQRVersionR9x139  RectMicroQRVersion = "R9x139"
	RectMicroQRVersionR11x27  RectMicroQRVersion = "R11x27"
	RectMicroQRVersionR11x43  RectMicroQRVersion = "R11x43"
	RectMicroQRVersionR11x59  RectMicroQRVersion = "R11x59"
	RectMicroQRVersionR11x77  RectMicroQRVersion = "R11x77"
	RectMicroQRVersionR11x99  RectMicroQRVersion = "R11x99"
	RectMicroQRVersionR11x139 RectMicroQRVersion = "R11x139"
	RectMicroQRVersionR13x27  RectMicroQRVersion = "R13x27"
	RectMicroQRVersionR13x43  RectMicroQRVersion = "R13x43"
	RectMicroQRVersionR13x59  RectMicroQRVersion = "R13x59"
	RectMicroQRVersionR13x77  RectMicroQRVersion = "R13x77"
	RectMicroQRVersionR13x99  RectMicroQRVersion = "R13x99"
	RectMicroQRVersionR13x139 RectMicroQRVersion = "R13x139"
	RectMicroQRVersionR15x43  RectMicroQRVersion = "R15x43"
	RectMicroQRVersionR15x59  RectMicroQRVersion = "R15x59"
	RectMicroQRVersionR15x77  RectMicroQRVersion = "R15x77"
	RectMicroQRVersionR15x99  RectMicroQRVersion = "R15x99"
	RectMicroQRVersionR15x139 RectMicroQRVersion = "R15x139"
	RectMicroQRVersionR17x43  RectMicroQRVersion = "R17x43"
	RectMicroQRVersionR17x59  RectMicroQRVersion = "R17x59"
	RectMicroQRVersionR17x77  RectMicroQRVersion = "R17x77"
	RectMicroQRVersionR17x99  RectMicroQRVersion = "R17x99"
	RectMicroQRVersionR17x139 RectMicroQRVersion = "R17x139"
)

List of RectMicroQRVersion

type RegionPoint

type RegionPoint struct {
	// X-coordinate
	X int32 `json:"x,omitempty"`
	// Y-coordinate
	Y int32 `json:"y,omitempty"`
}

RegionPoint - Wrapper around Drawing.Point for proper specification.

type ScanAPIService

type ScanAPIService service

ScanAPIService -

func (*ScanAPIService) Scan

* Scan - Scan a barcode from a file on an Internet server using a GET request with a query string parameter. For scanning files from your hard drive, use `scan-body` or `scan-multipart` endpoints instead. * @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @param fileUrl URL to the barcode image.

* @return BarcodeResponseList

func (*ScanAPIService) ScanBase64

func (a *ScanAPIService) ScanBase64(ctx context.Context, scanBase64Request ScanBase64Request) (BarcodeResponseList, *http.Response, error)

* ScanBase64 - Scan a barcode from a file in the request body using a POST request with a JSON or XML body parameter. * @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @param scanBase64Request Barcode scan request.

* @return BarcodeResponseList

func (*ScanAPIService) ScanMultipart

func (a *ScanAPIService) ScanMultipart(ctx context.Context, file *os.File) (BarcodeResponseList, *http.Response, error)

* ScanMultipart - Scan a barcode from a file in the request body using a POST request with a multipart form parameter. * @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @param file Barcode image file.

* @return BarcodeResponseList

type ScanBase64Request

type ScanBase64Request struct {
	// Barcode image bytes encoded as base-64.
	FileBase64 string `json:"fileBase64"`
}

ScanBase64Request - Scan barcode request.

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL