barcode

package
Version: v0.2212.0 Latest Latest
Warning

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

Go to latest
Published: Dec 19, 2022 License: MIT Imports: 19 Imported by: 0

Documentation

Index

Constants

This section is empty.

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

This section is empty.

Types

type APIClient

type APIClient struct {
	BarcodeApi *BarcodeApiService

	FileApi *FileApiService

	FolderApi *FolderApiService

	StorageApi *StorageApiService
	// contains filtered or unexported fields
}

APIClient manages communication with the Aspose.Barcode Cloud API Reference API v3.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 added in v0.2010.0

type ApiError struct {
	Code        string    `json:"Code,omitempty"`
	Message     string    `json:"Message,omitempty"`
	Description string    `json:"Description,omitempty"`
	DateTime    time.Time `json:"DateTime,omitempty"`
	InnerError  *ApiError `json:"InnerError,omitempty"`
}

ApiError -

type ApiErrorResponse added in v0.2010.0

type ApiErrorResponse struct {
	RequestId string   `json:"RequestId,omitempty"`
	Error     ApiError `json:"Error,omitempty"`
}

ApiErrorResponse -

type AustralianPostParams

type AustralianPostParams struct {
	// Interpreting type for the Customer Information of AustralianPost, default to CustomerInformationInterpretingType.Other\"
	EncodingTable CustomerInformationInterpretingType `json:"EncodingTable,omitempty"`
	// Short bar's height of AustralianPost barcode.
	ShortBarHeight float64 `json:"ShortBarHeight,omitempty"`
}

AustralianPostParams - AustralianPost barcode parameters.

type AutoSizeMode

type AutoSizeMode string

AutoSizeMode :

const (
	AutoSizeModeNone          AutoSizeMode = "None"
	AutoSizeModeNearest       AutoSizeMode = "Nearest"
	AutoSizeModeInterpolation AutoSizeMode = "Interpolation"
)

List of AutoSizeMode

type AvailableGraphicsUnit

type AvailableGraphicsUnit string

AvailableGraphicsUnit : Subset of GraphicsUnit.

const (
	AvailableGraphicsUnitPixel      AvailableGraphicsUnit = "Pixel"
	AvailableGraphicsUnitPoint      AvailableGraphicsUnit = "Point"
	AvailableGraphicsUnitInch       AvailableGraphicsUnit = "Inch"
	AvailableGraphicsUnitMillimeter AvailableGraphicsUnit = "Millimeter"
)

List of AvailableGraphicsUnit

type AztecParams

type AztecParams struct {
	// Height/Width ratio of 2D BarCode module.
	AspectRatio float64 `json:"AspectRatio,omitempty"`
	// Level of error correction of Aztec types of barcode. Value should between 10 to 95.
	ErrorLevel int32 `json:"ErrorLevel,omitempty"`
	// Aztec Symbol mode. Default value: AztecSymbolMode.Auto.
	SymbolMode AztecSymbolMode `json:"SymbolMode,omitempty"`
	// Sets the encoding of codetext.
	TextEncoding string `json:"TextEncoding,omitempty"`
}

AztecParams - Aztec parameters.

type AztecSymbolMode

type AztecSymbolMode string

AztecSymbolMode :

const (
	AztecSymbolModeAuto      AztecSymbolMode = "Auto"
	AztecSymbolModeCompact   AztecSymbolMode = "Compact"
	AztecSymbolModeFullRange AztecSymbolMode = "FullRange"
	AztecSymbolModeRune      AztecSymbolMode = "Rune"
)

List of AztecSymbolMode

type BarcodeApiGetBarcodeGenerateOpts

type BarcodeApiGetBarcodeGenerateOpts struct {
	TwoDDisplayText    optional.String
	TextLocation       optional.String
	TextAlignment      optional.String
	TextColor          optional.String
	FontSizeMode       optional.String
	NoWrap             optional.Bool
	Resolution         optional.Float64
	ResolutionX        optional.Float64
	ResolutionY        optional.Float64
	DimensionX         optional.Float64
	TextSpace          optional.Float64
	Units              optional.String
	SizeMode           optional.String
	BarHeight          optional.Float64
	ImageHeight        optional.Float64
	ImageWidth         optional.Float64
	RotationAngle      optional.Float64
	BackColor          optional.String
	BarColor           optional.String
	BorderColor        optional.String
	BorderWidth        optional.Float64
	BorderDashStyle    optional.String
	BorderVisible      optional.Bool
	EnableChecksum     optional.String
	EnableEscape       optional.Bool
	FilledBars         optional.Bool
	AlwaysShowChecksum optional.Bool
	WideNarrowRatio    optional.Float64
	ValidateText       optional.Bool
	SupplementData     optional.String
	SupplementSpace    optional.Float64
	BarWidthReduction  optional.Float64
	Format             optional.String
}

BarcodeApiGetBarcodeGenerateOpts - Optional Parameters for BarcodeApiGetBarcodeGenerate

type BarcodeApiGetBarcodeRecognizeOpts

type BarcodeApiGetBarcodeRecognizeOpts struct {
	Type_                                optional.String
	ChecksumValidation                   optional.String
	DetectEncoding                       optional.Bool
	Preset                               optional.String
	RectX                                optional.Int32
	RectY                                optional.Int32
	RectWidth                            optional.Int32
	RectHeight                           optional.Int32
	StripFNC                             optional.Bool
	Timeout                              optional.Int32
	MedianSmoothingWindowSize            optional.Int32
	AllowMedianSmoothing                 optional.Bool
	AllowComplexBackground               optional.Bool
	AllowDatamatrixIndustrialBarcodes    optional.Bool
	AllowDecreasedImage                  optional.Bool
	AllowDetectScanGap                   optional.Bool
	AllowIncorrectBarcodes               optional.Bool
	AllowInvertImage                     optional.Bool
	AllowMicroWhiteSpotsRemoving         optional.Bool
	AllowOneDFastBarcodesDetector        optional.Bool
	AllowOneDWipedBarsRestoration        optional.Bool
	AllowQRMicroQrRestoration            optional.Bool
	AllowRegularImage                    optional.Bool
	AllowSaltAndPepperFiltering          optional.Bool
	AllowWhiteSpotsRemoving              optional.Bool
	CheckMore1DVariants                  optional.Bool
	FastScanOnly                         optional.Bool
	RegionLikelihoodThresholdPercent     optional.Float64
	ScanWindowSizes                      optional.Interface
	Similarity                           optional.Float64
	SkipDiagonalSearch                   optional.Bool
	ReadTinyBarcodes                     optional.Bool
	AustralianPostEncodingTable          optional.String
	IgnoreEndingFillingPatternsForCTable optional.Bool
	RectangleRegion                      optional.String
	Storage                              optional.String
	Folder                               optional.String
}

BarcodeApiGetBarcodeRecognizeOpts - Optional Parameters for BarcodeApiGetBarcodeRecognize

type BarcodeApiPostBarcodeRecognizeFromUrlOrContentOpts

type BarcodeApiPostBarcodeRecognizeFromUrlOrContentOpts struct {
	Type_                                optional.String
	ChecksumValidation                   optional.String
	DetectEncoding                       optional.Bool
	Preset                               optional.String
	RectX                                optional.Int32
	RectY                                optional.Int32
	RectWidth                            optional.Int32
	RectHeight                           optional.Int32
	StripFNC                             optional.Bool
	Timeout                              optional.Int32
	MedianSmoothingWindowSize            optional.Int32
	AllowMedianSmoothing                 optional.Bool
	AllowComplexBackground               optional.Bool
	AllowDatamatrixIndustrialBarcodes    optional.Bool
	AllowDecreasedImage                  optional.Bool
	AllowDetectScanGap                   optional.Bool
	AllowIncorrectBarcodes               optional.Bool
	AllowInvertImage                     optional.Bool
	AllowMicroWhiteSpotsRemoving         optional.Bool
	AllowOneDFastBarcodesDetector        optional.Bool
	AllowOneDWipedBarsRestoration        optional.Bool
	AllowQRMicroQrRestoration            optional.Bool
	AllowRegularImage                    optional.Bool
	AllowSaltAndPepperFiltering          optional.Bool
	AllowWhiteSpotsRemoving              optional.Bool
	CheckMore1DVariants                  optional.Bool
	FastScanOnly                         optional.Bool
	RegionLikelihoodThresholdPercent     optional.Float64
	ScanWindowSizes                      optional.Interface
	Similarity                           optional.Float64
	SkipDiagonalSearch                   optional.Bool
	ReadTinyBarcodes                     optional.Bool
	AustralianPostEncodingTable          optional.String
	IgnoreEndingFillingPatternsForCTable optional.Bool
	RectangleRegion                      optional.String
	Url                                  optional.String
	Image                                optional.Interface
}

BarcodeApiPostBarcodeRecognizeFromUrlOrContentOpts - Optional Parameters for BarcodeApiPostBarcodeRecognizeFromUrlOrContent

type BarcodeApiPostGenerateMultipleOpts

type BarcodeApiPostGenerateMultipleOpts struct {
	Format optional.String
}

BarcodeApiPostGenerateMultipleOpts - Optional Parameters for BarcodeApiPostGenerateMultiple

type BarcodeApiPutBarcodeGenerateFileOpts

type BarcodeApiPutBarcodeGenerateFileOpts struct {
	TwoDDisplayText    optional.String
	TextLocation       optional.String
	TextAlignment      optional.String
	TextColor          optional.String
	FontSizeMode       optional.String
	NoWrap             optional.Bool
	Resolution         optional.Float64
	ResolutionX        optional.Float64
	ResolutionY        optional.Float64
	DimensionX         optional.Float64
	TextSpace          optional.Float64
	Units              optional.String
	SizeMode           optional.String
	BarHeight          optional.Float64
	ImageHeight        optional.Float64
	ImageWidth         optional.Float64
	RotationAngle      optional.Float64
	BackColor          optional.String
	BarColor           optional.String
	BorderColor        optional.String
	BorderWidth        optional.Float64
	BorderDashStyle    optional.String
	BorderVisible      optional.Bool
	EnableChecksum     optional.String
	EnableEscape       optional.Bool
	FilledBars         optional.Bool
	AlwaysShowChecksum optional.Bool
	WideNarrowRatio    optional.Float64
	ValidateText       optional.Bool
	SupplementData     optional.String
	SupplementSpace    optional.Float64
	BarWidthReduction  optional.Float64
	Storage            optional.String
	Folder             optional.String
	Format             optional.String
}

BarcodeApiPutBarcodeGenerateFileOpts - Optional Parameters for BarcodeApiPutBarcodeGenerateFile

type BarcodeApiPutBarcodeRecognizeFromBodyOpts

type BarcodeApiPutBarcodeRecognizeFromBodyOpts struct {
	Type_   optional.String
	Storage optional.String
	Folder  optional.String
}

BarcodeApiPutBarcodeRecognizeFromBodyOpts - Optional Parameters for BarcodeApiPutBarcodeRecognizeFromBody

type BarcodeApiPutGenerateMultipleOpts

type BarcodeApiPutGenerateMultipleOpts struct {
	Format  optional.String
	Folder  optional.String
	Storage optional.String
}

BarcodeApiPutGenerateMultipleOpts - Optional Parameters for BarcodeApiPutGenerateMultiple

type BarcodeApiService

type BarcodeApiService service

BarcodeApiService -

func (*BarcodeApiService) GetBarcodeGenerate

func (a *BarcodeApiService) GetBarcodeGenerate(ctx context.Context, type_ string, text string, optionals *BarcodeApiGetBarcodeGenerateOpts) ([]byte, *http.Response, error)

* GetBarcodeGenerate - Generate barcode. * @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @param type_ Type of barcode to generate. * @param text Text to encode. * @param optional nil or *BarcodeApiGetBarcodeGenerateOpts - Optional Parameters:

  • @param "TwoDDisplayText" (optional.String) - Text that will be displayed instead of codetext in 2D barcodes. Used for: Aztec, Pdf417, DataMatrix, QR, MaxiCode, DotCode
  • @param "TextLocation" (optional.String) - Specify the displaying Text Location, set to CodeLocation.None to hide CodeText. Default value: CodeLocation.Below.
  • @param "TextAlignment" (optional.String) - Text alignment.
  • @param "TextColor" (optional.String) - Specify the displaying CodeText's Color. Default value: Color.Black.
  • @param "FontSizeMode" (optional.String) - Specify FontSizeMode. If FontSizeMode is set to Auto, font size will be calculated automatically based on xDimension value. It is recommended to use FontSizeMode.Auto especially in AutoSizeMode.Nearest or AutoSizeMode.Interpolation. Default value: FontSizeMode.Auto.
  • @param "NoWrap" (optional.Bool) - Specify word wraps (line breaks) within text. Default value: false.
  • @param "Resolution" (optional.Float64) - Resolution of the BarCode image. One value for both dimensions. Default value: 96 dpi.
  • @param "ResolutionX" (optional.Float64) - DEPRECATED: Use 'Resolution' instead.
  • @param "ResolutionY" (optional.Float64) - DEPRECATED: Use 'Resolution' instead.
  • @param "DimensionX" (optional.Float64) - The smallest width of the unit of BarCode bars or spaces. Increase this will increase the whole barcode image width. Ignored if AutoSizeMode property is set to AutoSizeMode.Nearest or AutoSizeMode.Interpolation.
  • @param "TextSpace" (optional.Float64) - Space between the CodeText and the BarCode in Unit value. Default value: 2pt. Ignored for EAN8, EAN13, UPCE, UPCA, ISBN, ISMN, ISSN, UpcaGs1DatabarCoupon.
  • @param "Units" (optional.String) - Common Units for all measuring in query. Default units: pixel.
  • @param "SizeMode" (optional.String) - Specifies the different types of automatic sizing modes. Default value: AutoSizeMode.None.
  • @param "BarHeight" (optional.Float64) - Height of the barcode in given units. Default units: pixel.
  • @param "ImageHeight" (optional.Float64) - Height of the barcode image in given units. Default units: pixel.
  • @param "ImageWidth" (optional.Float64) - Width of the barcode image in given units. Default units: pixel.
  • @param "RotationAngle" (optional.Float64) - BarCode image rotation angle, measured in degree, e.g. RotationAngle = 0 or RotationAngle = 360 means no rotation. If RotationAngle NOT equal to 90, 180, 270 or 0, it may increase the difficulty for the scanner to read the image. Default value: 0.
  • @param "BackColor" (optional.String) - Background color of the barcode image. Default value: Color.White.
  • @param "BarColor" (optional.String) - Bars color. Default value: Color.Black.
  • @param "BorderColor" (optional.String) - Border color. Default value: Color.Black.
  • @param "BorderWidth" (optional.Float64) - Border width. Default value: 0. Ignored if Visible is set to false.
  • @param "BorderDashStyle" (optional.String) - Border dash style. Default value: BorderDashStyle.Solid.
  • @param "BorderVisible" (optional.Bool) - Border visibility. If false than parameter Width is always ignored (0). Default value: false.
  • @param "EnableChecksum" (optional.String) - Enable checksum during generation 1D barcodes. Default is treated as Yes for symbology which must contain checksum, as No where checksum only possible. Checksum is possible: Code39 Standard/Extended, Standard2of5, Interleaved2of5, Matrix2of5, ItalianPost25, DeutschePostIdentcode, DeutschePostLeitcode, VIN, Codabar Checksum always used: Rest symbology
  • @param "EnableEscape" (optional.Bool) - Indicates whether explains the character \"\\\" as an escape character in CodeText property. Used for Pdf417, DataMatrix, Code128 only If the EnableEscape is true, \"\\\" will be explained as a special escape character. Otherwise, \"\\\" acts as normal characters. Aspose.BarCode supports input decimal ascii code and mnemonic for ASCII control-code characters. For example, \\013 and \\\\CR stands for CR.
  • @param "FilledBars" (optional.Bool) - Value indicating whether bars are filled. Only for 1D barcodes. Default value: true.
  • @param "AlwaysShowChecksum" (optional.Bool) - Always display checksum digit in the human readable text for Code128 and GS1Code128 barcodes.
  • @param "WideNarrowRatio" (optional.Float64) - Wide bars to Narrow bars ratio. Default value: 3, that is, wide bars are 3 times as wide as narrow bars. Used for ITF, PZN, PharmaCode, Standard2of5, Interleaved2of5, Matrix2of5, ItalianPost25, IATA2of5, VIN, DeutschePost, OPC, Code32, DataLogic2of5, PatchCode, Code39Extended, Code39Standard
  • @param "ValidateText" (optional.Bool) - Only for 1D barcodes. If codetext is incorrect and value set to true - exception will be thrown. Otherwise codetext will be corrected to match barcode's specification. Exception always will be thrown for: Databar symbology if codetext is incorrect. Exception always will not be thrown for: AustraliaPost, SingaporePost, Code39Extended, Code93Extended, Code16K, Code128 symbology if codetext is incorrect.
  • @param "SupplementData" (optional.String) - Supplement parameters. Used for Interleaved2of5, Standard2of5, EAN13, EAN8, UPCA, UPCE, ISBN, ISSN, ISMN.
  • @param "SupplementSpace" (optional.Float64) - Space between main the BarCode and supplement BarCode.
  • @param "BarWidthReduction" (optional.Float64) - Bars reduction value that is used to compensate ink spread while printing.
  • @param "Format" (optional.String) - Result image format.

* @return []byte

func (*BarcodeApiService) GetBarcodeRecognize

* GetBarcodeRecognize - Recognize barcode from a file on server. * @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @param name The image file name. * @param optional nil or *BarcodeApiGetBarcodeRecognizeOpts - Optional Parameters:

  • @param "Type_" (optional.String) - The type of barcode to read.
  • @param "ChecksumValidation" (optional.String) - Enable checksum validation during recognition for 1D barcodes. Default is treated as Yes for symbologies which must contain checksum, as No where checksum only possible. Checksum never used: Codabar Checksum is possible: Code39 Standard/Extended, Standard2of5, Interleaved2of5, Matrix2of5, ItalianPost25, DeutschePostIdentcode, DeutschePostLeitcode, VIN Checksum always used: Rest symbologies
  • @param "DetectEncoding" (optional.Bool) - A flag which force engine to detect codetext encoding for Unicode.
  • @param "Preset" (optional.String) - Preset allows to configure recognition quality and speed manually. You can quickly set up Preset by embedded presets: HighPerformance, NormalQuality, HighQuality, MaxBarCodes or you can manually configure separate options. Default value of Preset is NormalQuality.
  • @param "RectX" (optional.Int32) - Set X for area for recognition.
  • @param "RectY" (optional.Int32) - Set Y for area for recognition.
  • @param "RectWidth" (optional.Int32) - Set Width of area for recognition.
  • @param "RectHeight" (optional.Int32) - Set Height of area for recognition.
  • @param "StripFNC" (optional.Bool) - Value indicating whether FNC symbol strip must be done.
  • @param "Timeout" (optional.Int32) - Timeout of recognition process.
  • @param "MedianSmoothingWindowSize" (optional.Int32) - Window size for median smoothing. Typical values are 3 or 4. Default value is 3. AllowMedianSmoothing must be set.
  • @param "AllowMedianSmoothing" (optional.Bool) - Allows engine to enable median smoothing as additional scan. Mode helps to recognize noised barcodes.
  • @param "AllowComplexBackground" (optional.Bool) - Allows engine to recognize color barcodes on color background as additional scan. Extremely slow mode.
  • @param "AllowDatamatrixIndustrialBarcodes" (optional.Bool) - Allows engine for Datamatrix to recognize dashed industrial Datamatrix barcodes. Slow mode which helps only for dashed barcodes which consist from spots.
  • @param "AllowDecreasedImage" (optional.Bool) - Allows engine to recognize decreased image as additional scan. Size for decreasing is selected by internal engine algorithms. Mode helps to recognize barcodes which are noised and blurred but captured with high resolution.
  • @param "AllowDetectScanGap" (optional.Bool) - Allows engine to use gap between scans to increase recognition speed. Mode can make recognition problems with low height barcodes.
  • @param "AllowIncorrectBarcodes" (optional.Bool) - Allows engine to recognize barcodes which has incorrect checksum or incorrect values. Mode can be used to recognize damaged barcodes with incorrect text.
  • @param "AllowInvertImage" (optional.Bool) - Allows engine to recognize inverse color image as additional scan. Mode can be used when barcode is white on black background.
  • @param "AllowMicroWhiteSpotsRemoving" (optional.Bool) - Allows engine for Postal barcodes to recognize slightly noised images. Mode helps to recognize slightly damaged Postal barcodes.
  • @param "AllowOneDFastBarcodesDetector" (optional.Bool) - Allows engine for 1D barcodes to quickly recognize high quality barcodes which fill almost whole image. Mode helps to quickly recognize generated barcodes from Internet.
  • @param "AllowOneDWipedBarsRestoration" (optional.Bool) - Allows engine for 1D barcodes to recognize barcodes with single wiped/glued bars in pattern.
  • @param "AllowQRMicroQrRestoration" (optional.Bool) - Allows engine for QR/MicroQR to recognize damaged MicroQR barcodes.
  • @param "AllowRegularImage" (optional.Bool) - Allows engine to recognize regular image without any restorations as main scan. Mode to recognize image as is.
  • @param "AllowSaltAndPepperFiltering" (optional.Bool) - Allows engine to recognize barcodes with salt and pepper noise type. Mode can remove small noise with white and black dots.
  • @param "AllowWhiteSpotsRemoving" (optional.Bool) - Allows engine to recognize image without small white spots as additional scan. Mode helps to recognize noised image as well as median smoothing filtering.
  • @param "CheckMore1DVariants" (optional.Bool) - Allows engine to recognize 1D barcodes with checksum by checking more recognition variants. Default value: False.
  • @param "FastScanOnly" (optional.Bool) - Allows engine for 1D barcodes to quickly recognize middle slice of an image and return result without using any time-consuming algorithms. Default value: False.
  • @param "RegionLikelihoodThresholdPercent" (optional.Float64) - Sets threshold for detected regions that may contain barcodes. Value 0.7 means that bottom 70% of possible regions are filtered out and not processed further. Region likelihood threshold must be between [0.05, 0.9] Use high values for clear images with few barcodes. Use low values for images with many barcodes or for noisy images. Low value may lead to a bigger recognition time.
  • @param "ScanWindowSizes" (optional.Interface of []int32) - Scan window sizes in pixels. Allowed sizes are 10, 15, 20, 25, 30. Scanning with small window size takes more time and provides more accuracy but may fail in detecting very big barcodes. Combining of several window sizes can improve detection quality.
  • @param "Similarity" (optional.Float64) - Similarity coefficient depends on how homogeneous barcodes are. Use high value for for clear barcodes. Use low values to detect barcodes that ara partly damaged or not lighten evenly. Similarity coefficient must be between [0.5, 0.9]
  • @param "SkipDiagonalSearch" (optional.Bool) - Allows detector to skip search for diagonal barcodes. Setting it to false will increase detection time but allow to find diagonal barcodes that can be missed otherwise. Enabling of diagonal search leads to a bigger detection time.
  • @param "ReadTinyBarcodes" (optional.Bool) - Allows engine to recognize tiny barcodes on large images. Ignored if AllowIncorrectBarcodes is set to True. Default value: False.
  • @param "AustralianPostEncodingTable" (optional.String) - Interpreting Type for the Customer Information of AustralianPost BarCode.Default is CustomerInformationInterpretingType.Other.
  • @param "IgnoreEndingFillingPatternsForCTable" (optional.Bool) - The flag which force AustraliaPost decoder to ignore last filling patterns in Customer Information Field during decoding as CTable method. CTable encoding method does not have any gaps in encoding table and sequnce \"333\" of filling paterns is decoded as letter \"z\".
  • @param "RectangleRegion" (optional.String) -
  • @param "Storage" (optional.String) - The image storage.
  • @param "Folder" (optional.String) - The image folder.

* @return BarcodeResponseList

func (*BarcodeApiService) PostBarcodeRecognizeFromUrlOrContent

func (a *BarcodeApiService) PostBarcodeRecognizeFromUrlOrContent(ctx context.Context, optionals *BarcodeApiPostBarcodeRecognizeFromUrlOrContentOpts) (BarcodeResponseList, *http.Response, error)

* PostBarcodeRecognizeFromUrlOrContent - Recognize barcode from an url or from request body. Request body can contain raw data bytes of the image or encoded with base64. * @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @param optional nil or *BarcodeApiPostBarcodeRecognizeFromUrlOrContentOpts - Optional Parameters:

  • @param "Type_" (optional.String) - The type of barcode to read.
  • @param "ChecksumValidation" (optional.String) - Enable checksum validation during recognition for 1D barcodes. Default is treated as Yes for symbologies which must contain checksum, as No where checksum only possible. Checksum never used: Codabar Checksum is possible: Code39 Standard/Extended, Standard2of5, Interleaved2of5, Matrix2of5, ItalianPost25, DeutschePostIdentcode, DeutschePostLeitcode, VIN Checksum always used: Rest symbologies
  • @param "DetectEncoding" (optional.Bool) - A flag which force engine to detect codetext encoding for Unicode.
  • @param "Preset" (optional.String) - Preset allows to configure recognition quality and speed manually. You can quickly set up Preset by embedded presets: HighPerformance, NormalQuality, HighQuality, MaxBarCodes or you can manually configure separate options. Default value of Preset is NormalQuality.
  • @param "RectX" (optional.Int32) - Set X for area for recognition.
  • @param "RectY" (optional.Int32) - Set Y for area for recognition.
  • @param "RectWidth" (optional.Int32) - Set Width of area for recognition.
  • @param "RectHeight" (optional.Int32) - Set Height of area for recognition.
  • @param "StripFNC" (optional.Bool) - Value indicating whether FNC symbol strip must be done.
  • @param "Timeout" (optional.Int32) - Timeout of recognition process.
  • @param "MedianSmoothingWindowSize" (optional.Int32) - Window size for median smoothing. Typical values are 3 or 4. Default value is 3. AllowMedianSmoothing must be set.
  • @param "AllowMedianSmoothing" (optional.Bool) - Allows engine to enable median smoothing as additional scan. Mode helps to recognize noised barcodes.
  • @param "AllowComplexBackground" (optional.Bool) - Allows engine to recognize color barcodes on color background as additional scan. Extremely slow mode.
  • @param "AllowDatamatrixIndustrialBarcodes" (optional.Bool) - Allows engine for Datamatrix to recognize dashed industrial Datamatrix barcodes. Slow mode which helps only for dashed barcodes which consist from spots.
  • @param "AllowDecreasedImage" (optional.Bool) - Allows engine to recognize decreased image as additional scan. Size for decreasing is selected by internal engine algorithms. Mode helps to recognize barcodes which are noised and blurred but captured with high resolution.
  • @param "AllowDetectScanGap" (optional.Bool) - Allows engine to use gap between scans to increase recognition speed. Mode can make recognition problems with low height barcodes.
  • @param "AllowIncorrectBarcodes" (optional.Bool) - Allows engine to recognize barcodes which has incorrect checksum or incorrect values. Mode can be used to recognize damaged barcodes with incorrect text.
  • @param "AllowInvertImage" (optional.Bool) - Allows engine to recognize inverse color image as additional scan. Mode can be used when barcode is white on black background.
  • @param "AllowMicroWhiteSpotsRemoving" (optional.Bool) - Allows engine for Postal barcodes to recognize slightly noised images. Mode helps to recognize slightly damaged Postal barcodes.
  • @param "AllowOneDFastBarcodesDetector" (optional.Bool) - Allows engine for 1D barcodes to quickly recognize high quality barcodes which fill almost whole image. Mode helps to quickly recognize generated barcodes from Internet.
  • @param "AllowOneDWipedBarsRestoration" (optional.Bool) - Allows engine for 1D barcodes to recognize barcodes with single wiped/glued bars in pattern.
  • @param "AllowQRMicroQrRestoration" (optional.Bool) - Allows engine for QR/MicroQR to recognize damaged MicroQR barcodes.
  • @param "AllowRegularImage" (optional.Bool) - Allows engine to recognize regular image without any restorations as main scan. Mode to recognize image as is.
  • @param "AllowSaltAndPepperFiltering" (optional.Bool) - Allows engine to recognize barcodes with salt and pepper noise type. Mode can remove small noise with white and black dots.
  • @param "AllowWhiteSpotsRemoving" (optional.Bool) - Allows engine to recognize image without small white spots as additional scan. Mode helps to recognize noised image as well as median smoothing filtering.
  • @param "CheckMore1DVariants" (optional.Bool) - Allows engine to recognize 1D barcodes with checksum by checking more recognition variants. Default value: False.
  • @param "FastScanOnly" (optional.Bool) - Allows engine for 1D barcodes to quickly recognize middle slice of an image and return result without using any time-consuming algorithms. Default value: False.
  • @param "RegionLikelihoodThresholdPercent" (optional.Float64) - Sets threshold for detected regions that may contain barcodes. Value 0.7 means that bottom 70% of possible regions are filtered out and not processed further. Region likelihood threshold must be between [0.05, 0.9] Use high values for clear images with few barcodes. Use low values for images with many barcodes or for noisy images. Low value may lead to a bigger recognition time.
  • @param "ScanWindowSizes" (optional.Interface of []int32) - Scan window sizes in pixels. Allowed sizes are 10, 15, 20, 25, 30. Scanning with small window size takes more time and provides more accuracy but may fail in detecting very big barcodes. Combining of several window sizes can improve detection quality.
  • @param "Similarity" (optional.Float64) - Similarity coefficient depends on how homogeneous barcodes are. Use high value for for clear barcodes. Use low values to detect barcodes that ara partly damaged or not lighten evenly. Similarity coefficient must be between [0.5, 0.9]
  • @param "SkipDiagonalSearch" (optional.Bool) - Allows detector to skip search for diagonal barcodes. Setting it to false will increase detection time but allow to find diagonal barcodes that can be missed otherwise. Enabling of diagonal search leads to a bigger detection time.
  • @param "ReadTinyBarcodes" (optional.Bool) - Allows engine to recognize tiny barcodes on large images. Ignored if AllowIncorrectBarcodes is set to True. Default value: False.
  • @param "AustralianPostEncodingTable" (optional.String) - Interpreting Type for the Customer Information of AustralianPost BarCode.Default is CustomerInformationInterpretingType.Other.
  • @param "IgnoreEndingFillingPatternsForCTable" (optional.Bool) - The flag which force AustraliaPost decoder to ignore last filling patterns in Customer Information Field during decoding as CTable method. CTable encoding method does not have any gaps in encoding table and sequnce \"333\" of filling paterns is decoded as letter \"z\".
  • @param "RectangleRegion" (optional.String) -
  • @param "Url" (optional.String) - The image file url.
  • @param "Image" (optional.Interface of *os.File) - Image data

* @return BarcodeResponseList

func (*BarcodeApiService) PostGenerateMultiple

func (a *BarcodeApiService) PostGenerateMultiple(ctx context.Context, generatorParamsList GeneratorParamsList, optionals *BarcodeApiPostGenerateMultipleOpts) ([]byte, *http.Response, error)

* PostGenerateMultiple - Generate multiple barcodes and return in response stream * @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @param generatorParamsList List of barcodes * @param optional nil or *BarcodeApiPostGenerateMultipleOpts - Optional Parameters:

  • @param "Format" (optional.String) - Format to return stream in

* @return []byte

func (*BarcodeApiService) PutBarcodeGenerateFile

func (a *BarcodeApiService) PutBarcodeGenerateFile(ctx context.Context, name string, type_ string, text string, optionals *BarcodeApiPutBarcodeGenerateFileOpts) (ResultImageInfo, *http.Response, error)

* PutBarcodeGenerateFile - Generate barcode and save on server (from query params or from file with json or xml content) * @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @param name The image file name. * @param type_ Type of barcode to generate. * @param text Text to encode. * @param optional nil or *BarcodeApiPutBarcodeGenerateFileOpts - Optional Parameters:

  • @param "TwoDDisplayText" (optional.String) - Text that will be displayed instead of codetext in 2D barcodes. Used for: Aztec, Pdf417, DataMatrix, QR, MaxiCode, DotCode
  • @param "TextLocation" (optional.String) - Specify the displaying Text Location, set to CodeLocation.None to hide CodeText. Default value: CodeLocation.Below.
  • @param "TextAlignment" (optional.String) - Text alignment.
  • @param "TextColor" (optional.String) - Specify the displaying CodeText's Color. Default value: Color.Black.
  • @param "FontSizeMode" (optional.String) - Specify FontSizeMode. If FontSizeMode is set to Auto, font size will be calculated automatically based on xDimension value. It is recommended to use FontSizeMode.Auto especially in AutoSizeMode.Nearest or AutoSizeMode.Interpolation. Default value: FontSizeMode.Auto.
  • @param "NoWrap" (optional.Bool) - Specify word wraps (line breaks) within text. Default value: false.
  • @param "Resolution" (optional.Float64) - Resolution of the BarCode image. One value for both dimensions. Default value: 96 dpi.
  • @param "ResolutionX" (optional.Float64) - DEPRECATED: Use 'Resolution' instead.
  • @param "ResolutionY" (optional.Float64) - DEPRECATED: Use 'Resolution' instead.
  • @param "DimensionX" (optional.Float64) - The smallest width of the unit of BarCode bars or spaces. Increase this will increase the whole barcode image width. Ignored if AutoSizeMode property is set to AutoSizeMode.Nearest or AutoSizeMode.Interpolation.
  • @param "TextSpace" (optional.Float64) - Space between the CodeText and the BarCode in Unit value. Default value: 2pt. Ignored for EAN8, EAN13, UPCE, UPCA, ISBN, ISMN, ISSN, UpcaGs1DatabarCoupon.
  • @param "Units" (optional.String) - Common Units for all measuring in query. Default units: pixel.
  • @param "SizeMode" (optional.String) - Specifies the different types of automatic sizing modes. Default value: AutoSizeMode.None.
  • @param "BarHeight" (optional.Float64) - Height of the barcode in given units. Default units: pixel.
  • @param "ImageHeight" (optional.Float64) - Height of the barcode image in given units. Default units: pixel.
  • @param "ImageWidth" (optional.Float64) - Width of the barcode image in given units. Default units: pixel.
  • @param "RotationAngle" (optional.Float64) - BarCode image rotation angle, measured in degree, e.g. RotationAngle = 0 or RotationAngle = 360 means no rotation. If RotationAngle NOT equal to 90, 180, 270 or 0, it may increase the difficulty for the scanner to read the image. Default value: 0.
  • @param "BackColor" (optional.String) - Background color of the barcode image. Default value: Color.White.
  • @param "BarColor" (optional.String) - Bars color. Default value: Color.Black.
  • @param "BorderColor" (optional.String) - Border color. Default value: Color.Black.
  • @param "BorderWidth" (optional.Float64) - Border width. Default value: 0. Ignored if Visible is set to false.
  • @param "BorderDashStyle" (optional.String) - Border dash style. Default value: BorderDashStyle.Solid.
  • @param "BorderVisible" (optional.Bool) - Border visibility. If false than parameter Width is always ignored (0). Default value: false.
  • @param "EnableChecksum" (optional.String) - Enable checksum during generation 1D barcodes. Default is treated as Yes for symbology which must contain checksum, as No where checksum only possible. Checksum is possible: Code39 Standard/Extended, Standard2of5, Interleaved2of5, Matrix2of5, ItalianPost25, DeutschePostIdentcode, DeutschePostLeitcode, VIN, Codabar Checksum always used: Rest symbology
  • @param "EnableEscape" (optional.Bool) - Indicates whether explains the character \"\\\" as an escape character in CodeText property. Used for Pdf417, DataMatrix, Code128 only If the EnableEscape is true, \"\\\" will be explained as a special escape character. Otherwise, \"\\\" acts as normal characters. Aspose.BarCode supports input decimal ascii code and mnemonic for ASCII control-code characters. For example, \\013 and \\\\CR stands for CR.
  • @param "FilledBars" (optional.Bool) - Value indicating whether bars are filled. Only for 1D barcodes. Default value: true.
  • @param "AlwaysShowChecksum" (optional.Bool) - Always display checksum digit in the human readable text for Code128 and GS1Code128 barcodes.
  • @param "WideNarrowRatio" (optional.Float64) - Wide bars to Narrow bars ratio. Default value: 3, that is, wide bars are 3 times as wide as narrow bars. Used for ITF, PZN, PharmaCode, Standard2of5, Interleaved2of5, Matrix2of5, ItalianPost25, IATA2of5, VIN, DeutschePost, OPC, Code32, DataLogic2of5, PatchCode, Code39Extended, Code39Standard
  • @param "ValidateText" (optional.Bool) - Only for 1D barcodes. If codetext is incorrect and value set to true - exception will be thrown. Otherwise codetext will be corrected to match barcode's specification. Exception always will be thrown for: Databar symbology if codetext is incorrect. Exception always will not be thrown for: AustraliaPost, SingaporePost, Code39Extended, Code93Extended, Code16K, Code128 symbology if codetext is incorrect.
  • @param "SupplementData" (optional.String) - Supplement parameters. Used for Interleaved2of5, Standard2of5, EAN13, EAN8, UPCA, UPCE, ISBN, ISSN, ISMN.
  • @param "SupplementSpace" (optional.Float64) - Space between main the BarCode and supplement BarCode.
  • @param "BarWidthReduction" (optional.Float64) - Bars reduction value that is used to compensate ink spread while printing.
  • @param "Storage" (optional.String) - Image's storage.
  • @param "Folder" (optional.String) - Image's folder.
  • @param "Format" (optional.String) - The image format.

* @return ResultImageInfo

func (*BarcodeApiService) PutBarcodeRecognizeFromBody

func (a *BarcodeApiService) PutBarcodeRecognizeFromBody(ctx context.Context, name string, readerParams ReaderParams, optionals *BarcodeApiPutBarcodeRecognizeFromBodyOpts) (BarcodeResponseList, *http.Response, error)

* PutBarcodeRecognizeFromBody - Recognition of a barcode from file on server with parameters in body. * @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @param name The image file name. * @param readerParams BarcodeReader object with parameters. * @param optional nil or *BarcodeApiPutBarcodeRecognizeFromBodyOpts - Optional Parameters:

  • @param "Type_" (optional.String) -
  • @param "Storage" (optional.String) - The storage name
  • @param "Folder" (optional.String) - The image folder.

* @return BarcodeResponseList

func (*BarcodeApiService) PutGenerateMultiple

func (a *BarcodeApiService) PutGenerateMultiple(ctx context.Context, name string, generatorParamsList GeneratorParamsList, optionals *BarcodeApiPutGenerateMultipleOpts) (ResultImageInfo, *http.Response, error)

* PutGenerateMultiple - Generate image with multiple barcodes and put new file on server * @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @param name New filename * @param generatorParamsList List of barcodes * @param optional nil or *BarcodeApiPutGenerateMultipleOpts - Optional Parameters:

  • @param "Format" (optional.String) - Format of file
  • @param "Folder" (optional.String) - Folder to place file to
  • @param "Storage" (optional.String) - The storage name

* @return ResultImageInfo

type BarcodeResponse

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

BarcodeResponse - Represents information about barcode.

type BarcodeResponseList

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

BarcodeResponseList - Represents information about 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 BorderDashStyle

type BorderDashStyle string

BorderDashStyle :

const (
	BorderDashStyleSolid      BorderDashStyle = "Solid"
	BorderDashStyleDash       BorderDashStyle = "Dash"
	BorderDashStyleDot        BorderDashStyle = "Dot"
	BorderDashStyleDashDot    BorderDashStyle = "DashDot"
	BorderDashStyleDashDotDot BorderDashStyle = "DashDotDot"
)

List of BorderDashStyle

type CaptionParams

type CaptionParams struct {
	// Caption text.
	Text string `json:"Text,omitempty"`
	// Text alignment.
	Alignment TextAlignment `json:"Alignment,omitempty"`
	// Text color.
	Color string `json:"Color,omitempty"`
	// Is caption visible.
	Visible bool `json:"Visible,omitempty"`
	// Font.
	Font FontParams `json:"Font,omitempty"`
	// Padding.
	Padding Padding `json:"Padding,omitempty"`
	// Specify word wraps (line breaks) within text. Default value: false.
	NoWrap bool `json:"NoWrap,omitempty"`
}

CaptionParams - Caption

type ChecksumValidation

type ChecksumValidation string

ChecksumValidation :

const (
	ChecksumValidationDefault ChecksumValidation = "Default"
	ChecksumValidationOn      ChecksumValidation = "On"
	ChecksumValidationOff     ChecksumValidation = "Off"
)

List of ChecksumValidation

type CodabarChecksumMode

type CodabarChecksumMode string

CodabarChecksumMode :

const (
	CodabarChecksumModeMod10 CodabarChecksumMode = "Mod10"
	CodabarChecksumModeMod16 CodabarChecksumMode = "Mod16"
)

List of CodabarChecksumMode

type CodabarParams

type CodabarParams struct {
	// Checksum algorithm for Codabar barcodes. Default value: CodabarChecksumMode.Mod16. To enable checksum calculation set value EnableChecksum.Yes to property EnableChecksum.
	ChecksumMode CodabarChecksumMode `json:"ChecksumMode,omitempty"`
	// Start symbol (character) of Codabar symbology. Default value: CodabarSymbol.A
	StartSymbol CodabarSymbol `json:"StartSymbol,omitempty"`
	// Stop symbol (character) of Codabar symbology. Default value: CodabarSymbol.A
	StopSymbol CodabarSymbol `json:"StopSymbol,omitempty"`
}

CodabarParams - Codabar parameters.

type CodabarSymbol

type CodabarSymbol string

CodabarSymbol :

const (
	CodabarSymbolA CodabarSymbol = "A"
	CodabarSymbolB CodabarSymbol = "B"
	CodabarSymbolC CodabarSymbol = "C"
	CodabarSymbolD CodabarSymbol = "D"
)

List of CodabarSymbol

type CodablockParams

type CodablockParams struct {
	// Height/Width ratio of 2D BarCode module.
	AspectRatio float64 `json:"AspectRatio,omitempty"`
	// Columns count.
	Columns int32 `json:"Columns,omitempty"`
	// Rows count.
	Rows int32 `json:"Rows,omitempty"`
}

CodablockParams - Codablock parameters.

type Code128Emulation added in v0.2103.0

type Code128Emulation string

Code128Emulation :

const (
	Code128EmulationNone    Code128Emulation = "None"
	Code128EmulationCode903 Code128Emulation = "Code903"
	Code128EmulationCode904 Code128Emulation = "Code904"
	Code128EmulationCode905 Code128Emulation = "Code905"
)

List of Code128Emulation

type Code16KParams

type Code16KParams struct {
	// Height/Width ratio of 2D BarCode module.
	AspectRatio float64 `json:"AspectRatio,omitempty"`
	// Size of the left quiet zone in xDimension. Default value: 10, meaning if xDimension = 2px than left quiet zone will be 20px.
	QuietZoneLeftCoef int32 `json:"QuietZoneLeftCoef,omitempty"`
	// Size of the right quiet zone in xDimension. Default value: 1, meaning if xDimension = 2px than right quiet zone will be 2px.
	QuietZoneRightCoef int32 `json:"QuietZoneRightCoef,omitempty"`
}

Code16KParams - Code16K parameters.

type CodeLocation

type CodeLocation string

CodeLocation :

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 CouponParams

type CouponParams struct {
	// Space between main the BarCode and supplement BarCode in Unit value.
	SupplementSpace float64 `json:"SupplementSpace,omitempty"`
}

CouponParams - Coupon parameters. Used for UpcaGs1DatabarCoupon, UpcaGs1Code128Coupon.

type CustomerInformationInterpretingType

type CustomerInformationInterpretingType string

CustomerInformationInterpretingType :

const (
	CustomerInformationInterpretingTypeCTable CustomerInformationInterpretingType = "CTable"
	CustomerInformationInterpretingTypeNTable CustomerInformationInterpretingType = "NTable"
	CustomerInformationInterpretingTypeOther  CustomerInformationInterpretingType = "Other"
)

List of CustomerInformationInterpretingType

type DataBarParams

type DataBarParams struct {
	// Height/Width ratio of 2D BarCode module. Used for DataBar stacked.
	AspectRatio float64 `json:"AspectRatio,omitempty"`
	// Columns count.
	Columns int32 `json:"Columns,omitempty"`
	// Rows count.
	Rows int32 `json:"Rows,omitempty"`
	// Enables flag of 2D composite component with DataBar barcode
	Is2DCompositeComponent bool `json:"Is2DCompositeComponent,omitempty"`
	// If this flag is set, it allows only GS1 encoding standard for Databar barcode types
	IsAllowOnlyGS1Encoding bool `json:"IsAllowOnlyGS1Encoding,omitempty"`
}

DataBarParams - Databar parameters.

type DataMatrixEccType

type DataMatrixEccType string

DataMatrixEccType :

const (
	DataMatrixEccTypeEccAuto DataMatrixEccType = "EccAuto"
	DataMatrixEccTypeEcc000  DataMatrixEccType = "Ecc000"
	DataMatrixEccTypeEcc050  DataMatrixEccType = "Ecc050"
	DataMatrixEccTypeEcc080  DataMatrixEccType = "Ecc080"
	DataMatrixEccTypeEcc100  DataMatrixEccType = "Ecc100"
	DataMatrixEccTypeEcc140  DataMatrixEccType = "Ecc140"
	DataMatrixEccTypeEcc200  DataMatrixEccType = "Ecc200"
)

List of DataMatrixEccType

type DataMatrixEncodeMode

type DataMatrixEncodeMode string

DataMatrixEncodeMode :

const (
	DataMatrixEncodeModeAuto             DataMatrixEncodeMode = "Auto"
	DataMatrixEncodeModeASCII            DataMatrixEncodeMode = "ASCII"
	DataMatrixEncodeModeFull             DataMatrixEncodeMode = "Full"
	DataMatrixEncodeModeCustom           DataMatrixEncodeMode = "Custom"
	DataMatrixEncodeModeC40              DataMatrixEncodeMode = "C40"
	DataMatrixEncodeModeText             DataMatrixEncodeMode = "Text"
	DataMatrixEncodeModeEDIFACT          DataMatrixEncodeMode = "EDIFACT"
	DataMatrixEncodeModeANSIX12          DataMatrixEncodeMode = "ANSIX12"
	DataMatrixEncodeModeExtendedCodetext DataMatrixEncodeMode = "ExtendedCodetext"
)

List of DataMatrixEncodeMode

type DataMatrixParams

type DataMatrixParams struct {
	// Height/Width ratio of 2D BarCode module
	AspectRatio float64 `json:"AspectRatio,omitempty"`
	// Encoding of codetext.
	TextEncoding string `json:"TextEncoding,omitempty"`
	// Columns count.
	Columns int32 `json:"Columns,omitempty"`
	// Datamatrix ECC type. Default value: DataMatrixEccType.Ecc200.
	DataMatrixEcc DataMatrixEccType `json:"DataMatrixEcc,omitempty"`
	// Encode mode of Datamatrix barcode. Default value: DataMatrixEncodeMode.Auto.
	DataMatrixEncodeMode DataMatrixEncodeMode `json:"DataMatrixEncodeMode,omitempty"`
	// Rows count.
	Rows int32 `json:"Rows,omitempty"`
	// Macro Characters 05 and 06 values are used to obtain more compact encoding in special modes. Can be used only with DataMatrixEccType.Ecc200 or DataMatrixEccType.EccAuto. Cannot be used with EncodeTypes.GS1DataMatrix Default value: MacroCharacters.None.
	MacroCharacters MacroCharacter `json:"MacroCharacters,omitempty"`
}

DataMatrixParams - DataMatrix parameters.

type DecodeBarcodeType

type DecodeBarcodeType string

DecodeBarcodeType : See DecodeType

const (
	DecodeBarcodeTypeall                           DecodeBarcodeType = "all"
	DecodeBarcodeTypeAustraliaPost                 DecodeBarcodeType = "AustraliaPost"
	DecodeBarcodeTypeAztec                         DecodeBarcodeType = "Aztec"
	DecodeBarcodeTypeISBN                          DecodeBarcodeType = "ISBN"
	DecodeBarcodeTypeCodabar                       DecodeBarcodeType = "Codabar"
	DecodeBarcodeTypeCode11                        DecodeBarcodeType = "Code11"
	DecodeBarcodeTypeCode128                       DecodeBarcodeType = "Code128"
	DecodeBarcodeTypeGS1Code128                    DecodeBarcodeType = "GS1Code128"
	DecodeBarcodeTypeCode39Extended                DecodeBarcodeType = "Code39Extended"
	DecodeBarcodeTypeCode39Standard                DecodeBarcodeType = "Code39Standard"
	DecodeBarcodeTypeCode93Extended                DecodeBarcodeType = "Code93Extended"
	DecodeBarcodeTypeCode93Standard                DecodeBarcodeType = "Code93Standard"
	DecodeBarcodeTypeDataMatrix                    DecodeBarcodeType = "DataMatrix"
	DecodeBarcodeTypeDeutschePostIdentcode         DecodeBarcodeType = "DeutschePostIdentcode"
	DecodeBarcodeTypeDeutschePostLeitcode          DecodeBarcodeType = "DeutschePostLeitcode"
	DecodeBarcodeTypeEAN13                         DecodeBarcodeType = "EAN13"
	DecodeBarcodeTypeEAN14                         DecodeBarcodeType = "EAN14"
	DecodeBarcodeTypeEAN8                          DecodeBarcodeType = "EAN8"
	DecodeBarcodeTypeIATA2of5                      DecodeBarcodeType = "IATA2of5"
	DecodeBarcodeTypeInterleaved2of5               DecodeBarcodeType = "Interleaved2of5"
	DecodeBarcodeTypeISSN                          DecodeBarcodeType = "ISSN"
	DecodeBarcodeTypeISMN                          DecodeBarcodeType = "ISMN"
	DecodeBarcodeTypeItalianPost25                 DecodeBarcodeType = "ItalianPost25"
	DecodeBarcodeTypeITF14                         DecodeBarcodeType = "ITF14"
	DecodeBarcodeTypeITF6                          DecodeBarcodeType = "ITF6"
	DecodeBarcodeTypeMacroPdf417                   DecodeBarcodeType = "MacroPdf417"
	DecodeBarcodeTypeMatrix2of5                    DecodeBarcodeType = "Matrix2of5"
	DecodeBarcodeTypeMSI                           DecodeBarcodeType = "MSI"
	DecodeBarcodeTypeOneCode                       DecodeBarcodeType = "OneCode"
	DecodeBarcodeTypeOPC                           DecodeBarcodeType = "OPC"
	DecodeBarcodeTypePatchCode                     DecodeBarcodeType = "PatchCode"
	DecodeBarcodeTypePdf417                        DecodeBarcodeType = "Pdf417"
	DecodeBarcodeTypeMicroPdf417                   DecodeBarcodeType = "MicroPdf417"
	DecodeBarcodeTypePlanet                        DecodeBarcodeType = "Planet"
	DecodeBarcodeTypePostnet                       DecodeBarcodeType = "Postnet"
	DecodeBarcodeTypePZN                           DecodeBarcodeType = "PZN"
	DecodeBarcodeTypeQR                            DecodeBarcodeType = "QR"
	DecodeBarcodeTypeMicroQR                       DecodeBarcodeType = "MicroQR"
	DecodeBarcodeTypeRM4SCC                        DecodeBarcodeType = "RM4SCC"
	DecodeBarcodeTypeSCC14                         DecodeBarcodeType = "SCC14"
	DecodeBarcodeTypeSSCC18                        DecodeBarcodeType = "SSCC18"
	DecodeBarcodeTypeStandard2of5                  DecodeBarcodeType = "Standard2of5"
	DecodeBarcodeTypeSupplement                    DecodeBarcodeType = "Supplement"
	DecodeBarcodeTypeUPCA                          DecodeBarcodeType = "UPCA"
	DecodeBarcodeTypeUPCE                          DecodeBarcodeType = "UPCE"
	DecodeBarcodeTypeVIN                           DecodeBarcodeType = "VIN"
	DecodeBarcodeTypePharmacode                    DecodeBarcodeType = "Pharmacode"
	DecodeBarcodeTypeGS1DataMatrix                 DecodeBarcodeType = "GS1DataMatrix"
	DecodeBarcodeTypeDatabarOmniDirectional        DecodeBarcodeType = "DatabarOmniDirectional"
	DecodeBarcodeTypeDatabarTruncated              DecodeBarcodeType = "DatabarTruncated"
	DecodeBarcodeTypeDatabarLimited                DecodeBarcodeType = "DatabarLimited"
	DecodeBarcodeTypeDatabarExpanded               DecodeBarcodeType = "DatabarExpanded"
	DecodeBarcodeTypeSwissPostParcel               DecodeBarcodeType = "SwissPostParcel"
	DecodeBarcodeTypeAustralianPosteParcel         DecodeBarcodeType = "AustralianPosteParcel"
	DecodeBarcodeTypeCode16K                       DecodeBarcodeType = "Code16K"
	DecodeBarcodeTypeDatabarStackedOmniDirectional DecodeBarcodeType = "DatabarStackedOmniDirectional"
	DecodeBarcodeTypeDatabarStacked                DecodeBarcodeType = "DatabarStacked"
	DecodeBarcodeTypeDatabarExpandedStacked        DecodeBarcodeType = "DatabarExpandedStacked"
	DecodeBarcodeTypeCompactPdf417                 DecodeBarcodeType = "CompactPdf417"
	DecodeBarcodeTypeGS1QR                         DecodeBarcodeType = "GS1QR"
	DecodeBarcodeTypeMaxiCode                      DecodeBarcodeType = "MaxiCode"
	DecodeBarcodeTypeMicrE13B                      DecodeBarcodeType = "MicrE13B"
	DecodeBarcodeTypeCode32                        DecodeBarcodeType = "Code32"
	DecodeBarcodeTypeDataLogic2of5                 DecodeBarcodeType = "DataLogic2of5"
	DecodeBarcodeTypeDotCode                       DecodeBarcodeType = "DotCode"
	DecodeBarcodeTypeDutchKIX                      DecodeBarcodeType = "DutchKIX"
	DecodeBarcodeTypeCodablockF                    DecodeBarcodeType = "CodablockF"
	DecodeBarcodeTypeMailmark                      DecodeBarcodeType = "Mailmark"
)

List of DecodeBarcodeType

type DiscUsage

type DiscUsage struct {
	// Application used disc space.
	UsedSize int64 `json:"UsedSize"`
	// Total disc space.
	TotalSize int64 `json:"TotalSize"`
}

DiscUsage - Class for disc space information.

type DotCodeParams

type DotCodeParams struct {
	// Height/Width ratio of 2D BarCode module.
	AspectRatio float64 `json:"AspectRatio,omitempty"`
	// DEPRECATED: DotCodeMask is now calculated automatically
	DotCodeMask int32 `json:"DotCodeMask,omitempty"`
}

DotCodeParams - DotCode parameters.

type EciEncodings

type EciEncodings string

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"
	EciEncodingsGB18030     EciEncodings = "GB18030"
	EciEncodingsEUC_KR      EciEncodings = "EUC_KR"
)

List of ECIEncodings

type EnableChecksum

type EnableChecksum string

EnableChecksum :

const (
	EnableChecksumDefault EnableChecksum = "Default"
	EnableChecksumYes     EnableChecksum = "Yes"
	EnableChecksumNo      EnableChecksum = "No"
)

List of EnableChecksum

type EncodeBarcodeType

type EncodeBarcodeType string

EncodeBarcodeType : See EncodeTypes

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

List of EncodeBarcodeType

type ErrorDetails

type ErrorDetails struct {
	// The request id
	RequestId string `json:"RequestId,omitempty"`
	// Date
	Date time.Time `json:"Date"`
}

ErrorDetails - The error details

type FileApiCopyFileOpts

type FileApiCopyFileOpts struct {
	SrcStorageName  optional.String
	DestStorageName optional.String
	VersionId       optional.String
}

FileApiCopyFileOpts - Optional Parameters for FileApiCopyFile

type FileApiDeleteFileOpts

type FileApiDeleteFileOpts struct {
	StorageName optional.String
	VersionId   optional.String
}

FileApiDeleteFileOpts - Optional Parameters for FileApiDeleteFile

type FileApiDownloadFileOpts

type FileApiDownloadFileOpts struct {
	StorageName optional.String
	VersionId   optional.String
}

FileApiDownloadFileOpts - Optional Parameters for FileApiDownloadFile

type FileApiMoveFileOpts

type FileApiMoveFileOpts struct {
	SrcStorageName  optional.String
	DestStorageName optional.String
	VersionId       optional.String
}

FileApiMoveFileOpts - Optional Parameters for FileApiMoveFile

type FileApiService

type FileApiService service

FileApiService -

func (*FileApiService) CopyFile

func (a *FileApiService) CopyFile(ctx context.Context, srcPath string, destPath string, optionals *FileApiCopyFileOpts) (*http.Response, error)

* CopyFile - Copy file * @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @param srcPath Source file path e.g. '/folder/file.ext' * @param destPath Destination file path * @param optional nil or *FileApiCopyFileOpts - Optional Parameters:

  • @param "SrcStorageName" (optional.String) - Source storage name
  • @param "DestStorageName" (optional.String) - Destination storage name
  • @param "VersionId" (optional.String) - File version ID to copy

func (*FileApiService) DeleteFile

func (a *FileApiService) DeleteFile(ctx context.Context, path string, optionals *FileApiDeleteFileOpts) (*http.Response, error)

* DeleteFile - Delete file * @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @param path File path e.g. '/folder/file.ext' * @param optional nil or *FileApiDeleteFileOpts - Optional Parameters:

  • @param "StorageName" (optional.String) - Storage name
  • @param "VersionId" (optional.String) - File version ID to delete

func (*FileApiService) DownloadFile

func (a *FileApiService) DownloadFile(ctx context.Context, path string, optionals *FileApiDownloadFileOpts) ([]byte, *http.Response, error)

* DownloadFile - Download file * @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @param path File path e.g. '/folder/file.ext' * @param optional nil or *FileApiDownloadFileOpts - Optional Parameters:

  • @param "StorageName" (optional.String) - Storage name
  • @param "VersionId" (optional.String) - File version ID to download

* @return []byte

func (*FileApiService) MoveFile

func (a *FileApiService) MoveFile(ctx context.Context, srcPath string, destPath string, optionals *FileApiMoveFileOpts) (*http.Response, error)

* MoveFile - Move file * @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @param srcPath Source file path e.g. '/src.ext' * @param destPath Destination file path e.g. '/dest.ext' * @param optional nil or *FileApiMoveFileOpts - Optional Parameters:

  • @param "SrcStorageName" (optional.String) - Source storage name
  • @param "DestStorageName" (optional.String) - Destination storage name
  • @param "VersionId" (optional.String) - File version ID to move

func (*FileApiService) UploadFile

func (a *FileApiService) UploadFile(ctx context.Context, path string, file *os.File, optionals *FileApiUploadFileOpts) (FilesUploadResult, *http.Response, error)

* UploadFile - Upload file * @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @param path Path where to upload including filename and extension e.g. /file.ext or /Folder 1/file.ext If the content is multipart and path does not contains the file name it tries to get them from filename parameter from Content-Disposition header. * @param file File to upload * @param optional nil or *FileApiUploadFileOpts - Optional Parameters:

  • @param "StorageName" (optional.String) - Storage name

* @return FilesUploadResult

type FileApiUploadFileOpts

type FileApiUploadFileOpts struct {
	StorageName optional.String
}

FileApiUploadFileOpts - Optional Parameters for FileApiUploadFile

type FileVersion

type FileVersion struct {
	// File or folder name.
	Name string `json:"Name,omitempty"`
	// True if it is a folder.
	IsFolder bool `json:"IsFolder"`
	// File or folder last modified DateTime.
	ModifiedDate time.Time `json:"ModifiedDate,omitempty"`
	// File or folder size.
	Size int64 `json:"Size"`
	// File or folder path.
	Path string `json:"Path,omitempty"`
	// File Version ID.
	VersionId string `json:"VersionId,omitempty"`
	// Specifies whether the file is (true) or is not (false) the latest version of an file.
	IsLatest bool `json:"IsLatest"`
}

FileVersion -

type FileVersions

type FileVersions struct {
	// File versions FileVersion.
	Value []FileVersion `json:"Value,omitempty"`
}

FileVersions - File versions FileVersion.

type FilesList

type FilesList struct {
	// Files and folders contained by folder StorageFile.
	Value []StorageFile `json:"Value,omitempty"`
}

FilesList - Files list

type FilesUploadResult

type FilesUploadResult struct {
	// List of uploaded file names
	Uploaded []string `json:"Uploaded,omitempty"`
	// List of errors.
	Errors []ModelError `json:"Errors,omitempty"`
}

FilesUploadResult - File upload result

type FolderApiCopyFolderOpts

type FolderApiCopyFolderOpts struct {
	SrcStorageName  optional.String
	DestStorageName optional.String
}

FolderApiCopyFolderOpts - Optional Parameters for FolderApiCopyFolder

type FolderApiCreateFolderOpts

type FolderApiCreateFolderOpts struct {
	StorageName optional.String
}

FolderApiCreateFolderOpts - Optional Parameters for FolderApiCreateFolder

type FolderApiDeleteFolderOpts

type FolderApiDeleteFolderOpts struct {
	StorageName optional.String
	Recursive   optional.Bool
}

FolderApiDeleteFolderOpts - Optional Parameters for FolderApiDeleteFolder

type FolderApiGetFilesListOpts

type FolderApiGetFilesListOpts struct {
	StorageName optional.String
}

FolderApiGetFilesListOpts - Optional Parameters for FolderApiGetFilesList

type FolderApiMoveFolderOpts

type FolderApiMoveFolderOpts struct {
	SrcStorageName  optional.String
	DestStorageName optional.String
}

FolderApiMoveFolderOpts - Optional Parameters for FolderApiMoveFolder

type FolderApiService

type FolderApiService service

FolderApiService -

func (*FolderApiService) CopyFolder

func (a *FolderApiService) CopyFolder(ctx context.Context, srcPath string, destPath string, optionals *FolderApiCopyFolderOpts) (*http.Response, error)

* CopyFolder - Copy folder * @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @param srcPath Source folder path e.g. '/src' * @param destPath Destination folder path e.g. '/dst' * @param optional nil or *FolderApiCopyFolderOpts - Optional Parameters:

  • @param "SrcStorageName" (optional.String) - Source storage name
  • @param "DestStorageName" (optional.String) - Destination storage name

func (*FolderApiService) CreateFolder

func (a *FolderApiService) CreateFolder(ctx context.Context, path string, optionals *FolderApiCreateFolderOpts) (*http.Response, error)

* CreateFolder - Create the folder * @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @param path Folder path to create e.g. 'folder_1/folder_2/' * @param optional nil or *FolderApiCreateFolderOpts - Optional Parameters:

  • @param "StorageName" (optional.String) - Storage name

func (*FolderApiService) DeleteFolder

func (a *FolderApiService) DeleteFolder(ctx context.Context, path string, optionals *FolderApiDeleteFolderOpts) (*http.Response, error)

* DeleteFolder - Delete folder * @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @param path Folder path e.g. '/folder' * @param optional nil or *FolderApiDeleteFolderOpts - Optional Parameters:

  • @param "StorageName" (optional.String) - Storage name
  • @param "Recursive" (optional.Bool) - Enable to delete folders, subfolders and files

func (*FolderApiService) GetFilesList

func (a *FolderApiService) GetFilesList(ctx context.Context, path string, optionals *FolderApiGetFilesListOpts) (FilesList, *http.Response, error)

* GetFilesList - Get all files and folders within a folder * @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @param path Folder path e.g. '/folder' * @param optional nil or *FolderApiGetFilesListOpts - Optional Parameters:

  • @param "StorageName" (optional.String) - Storage name

* @return FilesList

func (*FolderApiService) MoveFolder

func (a *FolderApiService) MoveFolder(ctx context.Context, srcPath string, destPath string, optionals *FolderApiMoveFolderOpts) (*http.Response, error)

* MoveFolder - Move folder * @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @param srcPath Folder path to move e.g. '/folder' * @param destPath Destination folder path to move to e.g '/dst' * @param optional nil or *FolderApiMoveFolderOpts - Optional Parameters:

  • @param "SrcStorageName" (optional.String) - Source storage name
  • @param "DestStorageName" (optional.String) - Destination storage name

type FontMode

type FontMode string

FontMode :

const (
	FontModeAuto   FontMode = "Auto"
	FontModeManual FontMode = "Manual"
)

List of FontMode

type FontParams

type FontParams struct {
	// Font family.
	Family string `json:"Family,omitempty"`
	// Font size in units.
	Size float64 `json:"Size,omitempty"`
	// Font style.
	Style FontStyle `json:"Style,omitempty"`
}

FontParams - Font.

type FontStyle

type FontStyle string

FontStyle :

const (
	FontStyleRegular   FontStyle = "Regular"
	FontStyleBold      FontStyle = "Bold"
	FontStyleItalic    FontStyle = "Italic"
	FontStyleUnderline FontStyle = "Underline"
	FontStyleStrikeout FontStyle = "Strikeout"
)

List of FontStyle

type GeneratorParams

type GeneratorParams struct {
	// Type of barcode to generate.
	TypeOfBarcode EncodeBarcodeType `json:"TypeOfBarcode"`
	// Text to encode.
	Text string `json:"Text"`
	// Text that will be displayed instead of codetext in 2D barcodes. Used for: Aztec, Pdf417, DataMatrix, QR, MaxiCode, DotCode
	TwoDDisplayText string `json:"TwoDDisplayText,omitempty"`
	// Specify the displaying Text Location, set to CodeLocation.None to hide CodeText. Default value: CodeLocation.Below.
	TextLocation CodeLocation `json:"TextLocation,omitempty"`
	// Text alignment.
	TextAlignment TextAlignment `json:"TextAlignment,omitempty"`
	// Specify the displaying CodeText's Color. Default value: Color.Black.
	TextColor string `json:"TextColor,omitempty"`
	// Specify the displaying Text's font. Default value: Arial 5pt regular. Ignored if FontSizeMode is set to FontSizeMode.Auto.
	Font FontParams `json:"Font,omitempty"`
	// Specify FontSizeMode. If FontSizeMode is set to Auto, font size will be calculated automatically based on xDimension value. It is recommended to use FontSizeMode.Auto especially in AutoSizeMode.Nearest or AutoSizeMode.Interpolation. Default value: FontSizeMode.Auto.
	FontSizeMode FontMode `json:"FontSizeMode,omitempty"`
	// Specify word wraps (line breaks) within text. Default value: false.
	NoWrap bool `json:"NoWrap,omitempty"`
	// Resolution of the BarCode image. One value for both dimensions. Default value: 96 dpi.
	Resolution float64 `json:"Resolution,omitempty"`
	// DEPRECATED: Use 'Resolution' instead.
	ResolutionX float64 `json:"ResolutionX,omitempty"`
	// DEPRECATED: Use 'Resolution' instead.
	ResolutionY float64 `json:"ResolutionY,omitempty"`
	// The smallest width of the unit of BarCode bars or spaces. Increase this will increase the whole barcode image width. Ignored if AutoSizeMode property is set to AutoSizeMode.Nearest or AutoSizeMode.Interpolation.
	DimensionX float64 `json:"DimensionX,omitempty"`
	// Space between the CodeText and the BarCode in Unit value. Default value: 2pt. Ignored for EAN8, EAN13, UPCE, UPCA, ISBN, ISMN, ISSN, UpcaGs1DatabarCoupon.
	TextSpace float64 `json:"TextSpace,omitempty"`
	// Common Units for all measuring in query. Default units: pixel.
	Units AvailableGraphicsUnit `json:"Units,omitempty"`
	// Specifies the different types of automatic sizing modes. Default value: AutoSizeMode.None.
	SizeMode AutoSizeMode `json:"SizeMode,omitempty"`
	// Height of the barcode in given units. Default units: pixel.
	BarHeight float64 `json:"BarHeight,omitempty"`
	// Height of the barcode image in given units. Default units: pixel.
	ImageHeight float64 `json:"ImageHeight,omitempty"`
	// Width of the barcode image in given units. Default units: pixel.
	ImageWidth float64 `json:"ImageWidth,omitempty"`
	// BarCode image rotation angle, measured in degree, e.g. RotationAngle = 0 or RotationAngle = 360 means no rotation. If RotationAngle NOT equal to 90, 180, 270 or 0, it may increase the difficulty for the scanner to read the image. Default value: 0.
	RotationAngle float64 `json:"RotationAngle,omitempty"`
	// Barcode paddings. Default value: 5pt 5pt 5pt 5pt.
	Padding Padding `json:"Padding,omitempty"`
	// Additional caption above barcode.
	CaptionAbove CaptionParams `json:"CaptionAbove,omitempty"`
	// Additional caption below barcode.
	CaptionBelow CaptionParams `json:"CaptionBelow,omitempty"`
	// Background color of the barcode image. Default value: Color.White.
	BackColor string `json:"BackColor,omitempty"`
	// Bars color. Default value: Color.Black.
	BarColor string `json:"BarColor,omitempty"`
	// Border color. Default value: Color.Black.
	BorderColor string `json:"BorderColor,omitempty"`
	// Border width. Default value: 0. Ignored if Visible is set to false.
	BorderWidth float64 `json:"BorderWidth,omitempty"`
	// Border dash style. Default value: BorderDashStyle.Solid.
	BorderDashStyle BorderDashStyle `json:"BorderDashStyle,omitempty"`
	// Border visibility. If false than parameter Width is always ignored (0). Default value: false.
	BorderVisible bool `json:"BorderVisible,omitempty"`
	// Enable checksum during generation 1D barcodes. Default is treated as Yes for symbology which must contain checksum, as No where checksum only possible. Checksum is possible: Code39 Standard/Extended, Standard2of5, Interleaved2of5, Matrix2of5, ItalianPost25, DeutschePostIdentcode, DeutschePostLeitcode, VIN, Codabar Checksum always used: Rest symbology
	EnableChecksum EnableChecksum `json:"EnableChecksum,omitempty"`
	// Indicates whether explains the character \"\\\" as an escape character in CodeText property. Used for Pdf417, DataMatrix, Code128 only If the EnableEscape is true, \"\\\" will be explained as a special escape character. Otherwise, \"\\\" acts as normal characters. Aspose.BarCode supports input decimal ascii code and mnemonic for ASCII control-code characters. For example, \\013 and \\\\CR stands for CR.
	EnableEscape bool `json:"EnableEscape,omitempty"`
	// Value indicating whether bars are filled. Only for 1D barcodes. Default value: true.
	FilledBars bool `json:"FilledBars,omitempty"`
	// Always display checksum digit in the human readable text for Code128 and GS1Code128 barcodes.
	AlwaysShowChecksum bool `json:"AlwaysShowChecksum,omitempty"`
	// Wide bars to Narrow bars ratio. Default value: 3, that is, wide bars are 3 times as wide as narrow bars. Used for ITF, PZN, PharmaCode, Standard2of5, Interleaved2of5, Matrix2of5, ItalianPost25, IATA2of5, VIN, DeutschePost, OPC, Code32, DataLogic2of5, PatchCode, Code39Extended, Code39Standard
	WideNarrowRatio float64 `json:"WideNarrowRatio,omitempty"`
	// Only for 1D barcodes. If codetext is incorrect and value set to true - exception will be thrown. Otherwise codetext will be corrected to match barcode's specification. Exception always will be thrown for: Databar symbology if codetext is incorrect. Exception always will not be thrown for: AustraliaPost, SingaporePost, Code39Extended, Code93Extended, Code16K, Code128 symbology if codetext is incorrect.
	ValidateText bool `json:"ValidateText,omitempty"`
	// Supplement parameters. Used for Interleaved2of5, Standard2of5, EAN13, EAN8, UPCA, UPCE, ISBN, ISSN, ISMN.
	SupplementData string `json:"SupplementData,omitempty"`
	// Space between main the BarCode and supplement BarCode.
	SupplementSpace float64 `json:"SupplementSpace,omitempty"`
	// Bars reduction value that is used to compensate ink spread while printing.
	BarWidthReduction float64 `json:"BarWidthReduction,omitempty"`
	// AustralianPost params.
	AustralianPost AustralianPostParams `json:"AustralianPost,omitempty"`
	// Aztec params.
	Aztec AztecParams `json:"Aztec,omitempty"`
	// Codabar params.
	Codabar CodabarParams `json:"Codabar,omitempty"`
	// Codablock params.
	Codablock CodablockParams `json:"Codablock,omitempty"`
	// Code16K params.
	Code16K Code16KParams `json:"Code16K,omitempty"`
	// Coupon params.
	Coupon CouponParams `json:"Coupon,omitempty"`
	// DataBar params.
	DataBar DataBarParams `json:"DataBar,omitempty"`
	// DataMatrix params.
	DataMatrix DataMatrixParams `json:"DataMatrix,omitempty"`
	// DotCode params.
	DotCode DotCodeParams `json:"DotCode,omitempty"`
	// ITF params.
	ITF ItfParams `json:"ITF,omitempty"`
	// MaxiCode params.
	MaxiCode MaxiCodeParams `json:"MaxiCode,omitempty"`
	// Pdf417 params.
	Pdf417 Pdf417Params `json:"Pdf417,omitempty"`
	// Postal params.
	Postal PostalParams `json:"Postal,omitempty"`
	// QR params.
	QR QrParams `json:"QR,omitempty"`
	// PatchCode params.
	PatchCode PatchCodeParams `json:"PatchCode,omitempty"`
}

GeneratorParams - Represents extended BarcodeGenerator params.

type GeneratorParamsList

type GeneratorParamsList struct {
	// List of barcode generators
	BarcodeBuilders []GeneratorParams `json:"BarcodeBuilders,omitempty"`
	// Shift step according to X axis
	XStep int32 `json:"XStep"`
	// Shift step according to Y axis
	YStep int32 `json:"YStep"`
}

GeneratorParamsList - Represents list of barcode generators

type GenericAPIError

type GenericAPIError struct {
	// 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 Itf14BorderType

type Itf14BorderType string

Itf14BorderType :

const (
	Itf14BorderTypeNone     Itf14BorderType = "None"
	Itf14BorderTypeFrame    Itf14BorderType = "Frame"
	Itf14BorderTypeBar      Itf14BorderType = "Bar"
	Itf14BorderTypeFrameOut Itf14BorderType = "FrameOut"
	Itf14BorderTypeBarOut   Itf14BorderType = "BarOut"
)

List of ITF14BorderType

type ItfParams

type ItfParams struct {
	// ITF border (bearer bar) thickness in Unit value. Default value: 12pt.
	BorderThickness float64 `json:"BorderThickness,omitempty"`
	// Border type of ITF barcode. Default value: ITF14BorderType.Bar.
	BorderType Itf14BorderType `json:"BorderType,omitempty"`
	// Size of the quiet zones in xDimension. Default value: 10, meaning if xDimension = 2px than quiet zones will be 20px.
	QuietZoneCoef int32 `json:"QuietZoneCoef,omitempty"`
}

ItfParams - ITF parameters.

type MacroCharacter added in v0.2012.1

type MacroCharacter string

MacroCharacter :

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

List of MacroCharacter

type MaxiCodeMode added in v0.2211.0

type MaxiCodeMode string

MaxiCodeMode :

const (
	MaxiCodeModeMode2 MaxiCodeMode = "Mode2"
	MaxiCodeModeMode3 MaxiCodeMode = "Mode3"
	MaxiCodeModeMode4 MaxiCodeMode = "Mode4"
	MaxiCodeModeMode5 MaxiCodeMode = "Mode5"
	MaxiCodeModeMode6 MaxiCodeMode = "Mode6"
)

List of MaxiCodeMode

type MaxiCodeParams

type MaxiCodeParams struct {
	// Height/Width ratio of 2D BarCode module.
	AspectRatio float64 `json:"AspectRatio,omitempty"`
	// Encoding mode for MaxiCode barcodes.
	Mode MaxiCodeMode `json:"Mode,omitempty"`
}

MaxiCodeParams - MaxiCode parameters.

type ModelError

type ModelError struct {
	// Code
	Code string `json:"Code,omitempty"`
	// Message
	Message string `json:"Message,omitempty"`
	// Description
	Description string `json:"Description,omitempty"`
	// Inner Error
	InnerError ErrorDetails `json:"InnerError,omitempty"`
}

ModelError - Error

type ObjectExist

type ObjectExist struct {
	// Indicates that the file or folder exists.
	Exists bool `json:"Exists"`
	// True if it is a folder, false if it is a file.
	IsFolder bool `json:"IsFolder"`
}

ObjectExist - Object exists

type Padding

type Padding struct {
	// Left padding.
	Left float64 `json:"Left,omitempty"`
	// Right padding.
	Right float64 `json:"Right,omitempty"`
	// Top padding.
	Top float64 `json:"Top,omitempty"`
	// Bottom padding.
	Bottom float64 `json:"Bottom,omitempty"`
}

Padding - Padding around barcode.

type PatchCodeParams added in v0.2008.0

type PatchCodeParams struct {
	// Specifies codetext for an extra QR barcode, when PatchCode is generated in page mode.
	ExtraBarcodeText string `json:"ExtraBarcodeText,omitempty"`
	// PatchCode format. Choose PatchOnly to generate single PatchCode. Use page format to generate Patch page with PatchCodes as borders. Default value: PatchFormat.PatchOnly
	PatchFormat PatchFormat `json:"PatchFormat,omitempty"`
}

PatchCodeParams - PatchCode parameters.

type PatchFormat added in v0.2008.0

type PatchFormat string

PatchFormat :

const (
	PatchFormatPatchOnly           PatchFormat = "PatchOnly"
	PatchFormatA4                  PatchFormat = "A4"
	PatchFormatA4_LANDSCAPE        PatchFormat = "A4_LANDSCAPE"
	PatchFormatUS_Letter           PatchFormat = "US_Letter"
	PatchFormatUS_Letter_LANDSCAPE PatchFormat = "US_Letter_LANDSCAPE"
)

List of PatchFormat

type Pdf417CompactionMode

type Pdf417CompactionMode string

Pdf417CompactionMode :

const (
	Pdf417CompactionModeAuto    Pdf417CompactionMode = "Auto"
	Pdf417CompactionModeText    Pdf417CompactionMode = "Text"
	Pdf417CompactionModeNumeric Pdf417CompactionMode = "Numeric"
	Pdf417CompactionModeBinary  Pdf417CompactionMode = "Binary"
)

List of Pdf417CompactionMode

type Pdf417ErrorLevel

type Pdf417ErrorLevel string

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 Pdf417MacroTerminator added in v0.2210.0

type Pdf417MacroTerminator string

Pdf417MacroTerminator :

const (
	Pdf417MacroTerminatorAuto Pdf417MacroTerminator = "Auto"
	Pdf417MacroTerminatorNone Pdf417MacroTerminator = "None"
	Pdf417MacroTerminatorSet  Pdf417MacroTerminator = "Set"
)

List of Pdf417MacroTerminator

type Pdf417Params

type Pdf417Params struct {
	// Height/Width ratio of 2D BarCode module.
	AspectRatio float64 `json:"AspectRatio,omitempty"`
	// Encoding of codetext.
	TextEncoding string `json:"TextEncoding,omitempty"`
	// Columns count.
	Columns int32 `json:"Columns,omitempty"`
	// Pdf417 symbology type of BarCode's compaction mode. Default value: Pdf417CompactionMode.Auto.
	CompactionMode Pdf417CompactionMode `json:"CompactionMode,omitempty"`
	// Pdf417 symbology type of BarCode's error correction level ranging from level0 to level8, level0 means no error correction info, level8 means best error correction which means a larger picture.
	ErrorLevel Pdf417ErrorLevel `json:"ErrorLevel,omitempty"`
	// Macro Pdf417 barcode's file ID. Used for MacroPdf417.
	MacroFileID int32 `json:"MacroFileID,omitempty"`
	// Macro Pdf417 barcode's segment ID, which starts from 0, to MacroSegmentsCount - 1.
	MacroSegmentID int32 `json:"MacroSegmentID,omitempty"`
	// Macro Pdf417 barcode segments count.
	MacroSegmentsCount int32 `json:"MacroSegmentsCount,omitempty"`
	// Rows count.
	Rows int32 `json:"Rows,omitempty"`
	// Whether Pdf417 symbology type of BarCode is truncated (to reduce space).
	Truncate bool `json:"Truncate,omitempty"`
	// Extended Channel Interpretation Identifiers. It is used to tell the barcode reader details about the used references for encoding the data in the symbol. Current implementation consists all well known charset encodings.
	Pdf417ECIEncoding EciEncodings `json:"Pdf417ECIEncoding,omitempty"`
	// Used to instruct the reader to interpret the data contained within the symbol as programming for reader initialization
	IsReaderInitialization bool `json:"IsReaderInitialization,omitempty"`
	// Macro Pdf417 barcode time stamp
	MacroTimeStamp time.Time `json:"MacroTimeStamp,omitempty"`
	// Macro Pdf417 barcode sender name
	MacroSender string `json:"MacroSender,omitempty"`
	// Macro Pdf417 file size. The file size field contains the size in bytes of the entire source file
	MacroFileSize int32 `json:"MacroFileSize,omitempty"`
	// Macro Pdf417 barcode checksum. The checksum field contains the value of the 16-bit (2 bytes) CRC checksum using the CCITT-16 polynomial
	MacroChecksum int32 `json:"MacroChecksum,omitempty"`
	// Macro Pdf417 barcode file name
	MacroFileName string `json:"MacroFileName,omitempty"`
	// Macro Pdf417 barcode addressee name
	MacroAddressee string `json:"MacroAddressee,omitempty"`
	// Extended Channel Interpretation Identifiers. Applies for Macro PDF417 text fields.
	MacroECIEncoding EciEncodings `json:"MacroECIEncoding,omitempty"`
	// Function codeword for Code 128 emulation. Applied for MicroPDF417 only. Ignored for PDF417 and MacroPDF417 barcodes.
	Code128Emulation Code128Emulation `json:"Code128Emulation,omitempty"`
	// Used to tell the encoder whether to add Macro PDF417 Terminator (codeword 922) to the segment. Applied only for Macro PDF417.
	Pdf417MacroTerminator Pdf417MacroTerminator `json:"Pdf417MacroTerminator,omitempty"`
}

Pdf417Params - PDF417 parameters.

type PostalParams

type PostalParams struct {
	// Short bar's height of Postal barcodes.
	ShortBarHeight float64 `json:"ShortBarHeight,omitempty"`
}

PostalParams - Postal parameters. Used for Postnet, Planet.

type PresetType

type PresetType string

PresetType : See QualitySettings allows to configure recognition quality and speed manually.

const (
	PresetTypeHighPerformance      PresetType = "HighPerformance"
	PresetTypeNormalQuality        PresetType = "NormalQuality"
	PresetTypeHighQualityDetection PresetType = "HighQualityDetection"
	PresetTypeMaxQualityDetection  PresetType = "MaxQualityDetection"
	PresetTypeHighQuality          PresetType = "HighQuality"
	PresetTypeMaxBarCodes          PresetType = "MaxBarCodes"
)

List of PresetType

type QrEncodeMode

type QrEncodeMode string

QrEncodeMode :

const (
	QrEncodeModeAuto             QrEncodeMode = "Auto"
	QrEncodeModeBytes            QrEncodeMode = "Bytes"
	QrEncodeModeUtf8BOM          QrEncodeMode = "Utf8BOM"
	QrEncodeModeUtf16BEBOM       QrEncodeMode = "Utf16BEBOM"
	QrEncodeModeECIEncoding      QrEncodeMode = "ECIEncoding"
	QrEncodeModeExtendedCodetext QrEncodeMode = "ExtendedCodetext"
)

List of QREncodeMode

type QrEncodeType

type QrEncodeType string

QrEncodeType :

const (
	QrEncodeTypeAuto         QrEncodeType = "Auto"
	QrEncodeTypeForceQR      QrEncodeType = "ForceQR"
	QrEncodeTypeForceMicroQR QrEncodeType = "ForceMicroQR"
)

List of QREncodeType

type QrErrorLevel

type QrErrorLevel string

QrErrorLevel :

const (
	QrErrorLevelLevelL QrErrorLevel = "LevelL"
	QrErrorLevelLevelM QrErrorLevel = "LevelM"
	QrErrorLevelLevelQ QrErrorLevel = "LevelQ"
	QrErrorLevelLevelH QrErrorLevel = "LevelH"
)

List of QRErrorLevel

type QrParams

type QrParams struct {
	// Height/Width ratio of 2D BarCode module.
	AspectRatio float64 `json:"AspectRatio,omitempty"`
	// Encoding of codetext.
	TextEncoding string `json:"TextEncoding,omitempty"`
	// QR / MicroQR selector mode. Select ForceQR for standard QR symbols, Auto for MicroQR.
	EncodeType QrEncodeType `json:"EncodeType,omitempty"`
	// Extended Channel Interpretation Identifiers. It is used to tell the barcode reader details about the used references for encoding the data in the symbol. Current implementation consists all well known charset encodings.
	ECIEncoding EciEncodings `json:"ECIEncoding,omitempty"`
	// QR symbology type of BarCode's encoding mode. Default value: QREncodeMode.Auto.
	EncodeMode QrEncodeMode `json:"EncodeMode,omitempty"`
	// Level of Reed-Solomon error correction for QR barcode. From low to high: LevelL, LevelM, LevelQ, LevelH. see QRErrorLevel.
	ErrorLevel QrErrorLevel `json:"ErrorLevel,omitempty"`
	// Version of QR Code. From Version1 to Version40 for QR code and from M1 to M4 for MicroQr. Default value is QRVersion.Auto.
	Version QrVersion `json:"Version,omitempty"`
	// QR structured append parameters.
	StructuredAppend StructuredAppend `json:"StructuredAppend,omitempty"`
}

QrParams - QR parameters.

type QrVersion

type QrVersion string

QrVersion :

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"
	QrVersionVersionM1 QrVersion = "VersionM1"
	QrVersionVersionM2 QrVersion = "VersionM2"
	QrVersionVersionM3 QrVersion = "VersionM3"
	QrVersionVersionM4 QrVersion = "VersionM4"
)

List of QRVersion

type ReaderParams

type ReaderParams struct {
	// The type of barcode to read.
	Type DecodeBarcodeType `json:"Type,omitempty"`
	// Enable checksum validation during recognition for 1D barcodes. Default is treated as Yes for symbologies which must contain checksum, as No where checksum only possible. Checksum never used: Codabar Checksum is possible: Code39 Standard/Extended, Standard2of5, Interleaved2of5, Matrix2of5, ItalianPost25, DeutschePostIdentcode, DeutschePostLeitcode, VIN Checksum always used: Rest symbologies
	ChecksumValidation ChecksumValidation `json:"ChecksumValidation,omitempty"`
	// A flag which force engine to detect codetext encoding for Unicode.
	DetectEncoding bool `json:"DetectEncoding,omitempty"`
	// Preset allows to configure recognition quality and speed manually. You can quickly set up Preset by embedded presets: HighPerformance, NormalQuality, HighQuality, MaxBarCodes or you can manually configure separate options. Default value of Preset is NormalQuality.
	Preset PresetType `json:"Preset,omitempty"`
	// Set X for area for recognition.
	RectX int32 `json:"RectX,omitempty"`
	// Set Y for area for recognition.
	RectY int32 `json:"RectY,omitempty"`
	// Set Width of area for recognition.
	RectWidth int32 `json:"RectWidth,omitempty"`
	// Set Height of area for recognition.
	RectHeight int32 `json:"RectHeight,omitempty"`
	// Value indicating whether FNC symbol strip must be done.
	StripFNC bool `json:"StripFNC,omitempty"`
	// Timeout of recognition process.
	Timeout int32 `json:"Timeout,omitempty"`
	// Window size for median smoothing. Typical values are 3 or 4. Default value is 3. AllowMedianSmoothing must be set.
	MedianSmoothingWindowSize int32 `json:"MedianSmoothingWindowSize,omitempty"`
	// Allows engine to enable median smoothing as additional scan. Mode helps to recognize noised barcodes.
	AllowMedianSmoothing bool `json:"AllowMedianSmoothing,omitempty"`
	// Allows engine to recognize color barcodes on color background as additional scan. Extremely slow mode.
	AllowComplexBackground bool `json:"AllowComplexBackground,omitempty"`
	// Allows engine for Datamatrix to recognize dashed industrial Datamatrix barcodes. Slow mode which helps only for dashed barcodes which consist from spots.
	AllowDatamatrixIndustrialBarcodes bool `json:"AllowDatamatrixIndustrialBarcodes,omitempty"`
	// Allows engine to recognize decreased image as additional scan. Size for decreasing is selected by internal engine algorithms. Mode helps to recognize barcodes which are noised and blurred but captured with high resolution.
	AllowDecreasedImage bool `json:"AllowDecreasedImage,omitempty"`
	// Allows engine to use gap between scans to increase recognition speed. Mode can make recognition problems with low height barcodes.
	AllowDetectScanGap bool `json:"AllowDetectScanGap,omitempty"`
	// Allows engine to recognize barcodes which has incorrect checksum or incorrect values. Mode can be used to recognize damaged barcodes with incorrect text.
	AllowIncorrectBarcodes bool `json:"AllowIncorrectBarcodes,omitempty"`
	// Allows engine to recognize inverse color image as additional scan. Mode can be used when barcode is white on black background.
	AllowInvertImage bool `json:"AllowInvertImage,omitempty"`
	// Allows engine for Postal barcodes to recognize slightly noised images. Mode helps to recognize slightly damaged Postal barcodes.
	AllowMicroWhiteSpotsRemoving bool `json:"AllowMicroWhiteSpotsRemoving,omitempty"`
	// Allows engine for 1D barcodes to quickly recognize high quality barcodes which fill almost whole image. Mode helps to quickly recognize generated barcodes from Internet.
	AllowOneDFastBarcodesDetector bool `json:"AllowOneDFastBarcodesDetector,omitempty"`
	// Allows engine for 1D barcodes to recognize barcodes with single wiped/glued bars in pattern.
	AllowOneDWipedBarsRestoration bool `json:"AllowOneDWipedBarsRestoration,omitempty"`
	// Allows engine for QR/MicroQR to recognize damaged MicroQR barcodes.
	AllowQRMicroQrRestoration bool `json:"AllowQRMicroQrRestoration,omitempty"`
	// Allows engine to recognize regular image without any restorations as main scan. Mode to recognize image as is.
	AllowRegularImage bool `json:"AllowRegularImage,omitempty"`
	// Allows engine to recognize barcodes with salt and pepper noise type. Mode can remove small noise with white and black dots.
	AllowSaltAndPepperFiltering bool `json:"AllowSaltAndPepperFiltering,omitempty"`
	// Allows engine to recognize image without small white spots as additional scan. Mode helps to recognize noised image as well as median smoothing filtering.
	AllowWhiteSpotsRemoving bool `json:"AllowWhiteSpotsRemoving,omitempty"`
	// Allows engine to recognize 1D barcodes with checksum by checking more recognition variants. Default value: False.
	CheckMore1DVariants bool `json:"CheckMore1DVariants,omitempty"`
	// Allows engine for 1D barcodes to quickly recognize middle slice of an image and return result without using any time-consuming algorithms. Default value: False.
	FastScanOnly bool `json:"FastScanOnly,omitempty"`
	// Sets threshold for detected regions that may contain barcodes. Value 0.7 means that bottom 70% of possible regions are filtered out and not processed further. Region likelihood threshold must be between [0.05, 0.9] Use high values for clear images with few barcodes. Use low values for images with many barcodes or for noisy images. Low value may lead to a bigger recognition time.
	RegionLikelihoodThresholdPercent float64 `json:"RegionLikelihoodThresholdPercent,omitempty"`
	// Scan window sizes in pixels. Allowed sizes are 10, 15, 20, 25, 30. Scanning with small window size takes more time and provides more accuracy but may fail in detecting very big barcodes. Combining of several window sizes can improve detection quality.
	ScanWindowSizes []int32 `json:"ScanWindowSizes,omitempty"`
	// Similarity coefficient depends on how homogeneous barcodes are. Use high value for for clear barcodes. Use low values to detect barcodes that ara partly damaged or not lighten evenly. Similarity coefficient must be between [0.5, 0.9]
	Similarity float64 `json:"Similarity,omitempty"`
	// Allows detector to skip search for diagonal barcodes. Setting it to false will increase detection time but allow to find diagonal barcodes that can be missed otherwise. Enabling of diagonal search leads to a bigger detection time.
	SkipDiagonalSearch bool `json:"SkipDiagonalSearch,omitempty"`
	// Allows engine to recognize tiny barcodes on large images. Ignored if AllowIncorrectBarcodes is set to True. Default value: False.
	ReadTinyBarcodes bool `json:"ReadTinyBarcodes,omitempty"`
	// Interpreting Type for the Customer Information of AustralianPost BarCode.Default is CustomerInformationInterpretingType.Other.
	AustralianPostEncodingTable CustomerInformationInterpretingType `json:"AustralianPostEncodingTable,omitempty"`
	// The flag which force AustraliaPost decoder to ignore last filling patterns in Customer Information Field during decoding as CTable method. CTable encoding method does not have any gaps in encoding table and sequnce \"333\" of filling paterns is decoded as letter \"z\".
	IgnoreEndingFillingPatternsForCTable bool `json:"IgnoreEndingFillingPatternsForCTable,omitempty"`
}

ReaderParams - Represents BarcodeReader object.

type RegionPoint

type RegionPoint struct {
	// X-coordinate
	X int32 `json:"X"`
	// Y-coordinate
	Y int32 `json:"Y"`
}

RegionPoint - Wrapper around Drawing.Point for proper specification.

type ResultImageInfo

type ResultImageInfo struct {
	// Result file size.
	FileSize int64 `json:"FileSize"`
	// Result image width.
	ImageWidth int32 `json:"ImageWidth,omitempty"`
	// Result image height.
	ImageHeight int32 `json:"ImageHeight,omitempty"`
}

ResultImageInfo - Created image info.

type StorageApiGetDiscUsageOpts

type StorageApiGetDiscUsageOpts struct {
	StorageName optional.String
}

StorageApiGetDiscUsageOpts - Optional Parameters for StorageApiGetDiscUsage

type StorageApiGetFileVersionsOpts

type StorageApiGetFileVersionsOpts struct {
	StorageName optional.String
}

StorageApiGetFileVersionsOpts - Optional Parameters for StorageApiGetFileVersions

type StorageApiObjectExistsOpts

type StorageApiObjectExistsOpts struct {
	StorageName optional.String
	VersionId   optional.String
}

StorageApiObjectExistsOpts - Optional Parameters for StorageApiObjectExists

type StorageApiService

type StorageApiService service

StorageApiService -

func (*StorageApiService) GetDiscUsage

* GetDiscUsage - Get disc usage * @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @param optional nil or *StorageApiGetDiscUsageOpts - Optional Parameters:

  • @param "StorageName" (optional.String) - Storage name

* @return DiscUsage

func (*StorageApiService) GetFileVersions

func (a *StorageApiService) GetFileVersions(ctx context.Context, path string, optionals *StorageApiGetFileVersionsOpts) (FileVersions, *http.Response, error)

* GetFileVersions - Get file versions * @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @param path File path e.g. '/file.ext' * @param optional nil or *StorageApiGetFileVersionsOpts - Optional Parameters:

  • @param "StorageName" (optional.String) - Storage name

* @return FileVersions

func (*StorageApiService) ObjectExists

func (a *StorageApiService) ObjectExists(ctx context.Context, path string, optionals *StorageApiObjectExistsOpts) (ObjectExist, *http.Response, error)

* ObjectExists - Check if file or folder exists * @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @param path File or folder path e.g. '/file.ext' or '/folder' * @param optional nil or *StorageApiObjectExistsOpts - Optional Parameters:

  • @param "StorageName" (optional.String) - Storage name
  • @param "VersionId" (optional.String) - File version ID

* @return ObjectExist

func (*StorageApiService) StorageExists

func (a *StorageApiService) StorageExists(ctx context.Context, storageName string) (StorageExist, *http.Response, error)

* StorageExists - Check if storage exists * @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @param storageName Storage name

* @return StorageExist

type StorageExist

type StorageExist struct {
	// Shows that the storage exists.
	Exists bool `json:"Exists"`
}

StorageExist - Storage exists

type StorageFile

type StorageFile struct {
	// File or folder name.
	Name string `json:"Name,omitempty"`
	// True if it is a folder.
	IsFolder bool `json:"IsFolder"`
	// File or folder last modified DateTime.
	ModifiedDate time.Time `json:"ModifiedDate,omitempty"`
	// File or folder size.
	Size int64 `json:"Size"`
	// File or folder path.
	Path string `json:"Path,omitempty"`
}

StorageFile - File or folder information

type StructuredAppend added in v0.2012.1

type StructuredAppend struct {
	// The index of the QR structured append mode barcode. Index starts from 0.
	SequenceIndicator int32 `json:"SequenceIndicator,omitempty"`
	// QR structured append mode barcodes quantity. Max value is 16.
	TotalCount int32 `json:"TotalCount,omitempty"`
	// QR structured append mode parity data.
	ParityByte int32 `json:"ParityByte,omitempty"`
}

StructuredAppend - QR structured append parameters.

type TextAlignment

type TextAlignment string

TextAlignment :

const (
	TextAlignmentLeft   TextAlignment = "Left"
	TextAlignmentCenter TextAlignment = "Center"
	TextAlignmentRight  TextAlignment = "Right"
)

List of TextAlignment

Source Files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

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