Skip to content

Group new params #129

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ivankamkin wants to merge 1 commit into
base: release-26.6
Choose a base branch
from
Open

Group new params #129

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Tests/ApiExceptionTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ public void GetBarcodeGenerateAsyncTestThrows()
async () =>
{
await api.GenerateAsync(data: "Very sample text",
barcodeType: EncodeBarcodeType.Code128, imageFormat: BarcodeImageFormat.Png);
barcodeType: EncodeBarcodeType.Code128, barcodeImageParams: new BarcodeImageParams { ImageFormat = BarcodeImageFormat.Png });
});

Assert.AreEqual(400, ex!.ErrorCode);
Expand Down
2 changes: 1 addition & 1 deletion docs/ApiError.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,4 @@ Name | Type | Description | Notes
**Message** | **string** | Gets or sets error message. |
**Description** | **string** | Gets or sets error description. | [optional]
**DateTime** | **DateTime?** | Gets or sets server datetime. | [optional]
**InnerError** | [**ApiError**](ApiError.md) | | [optional]
**InnerError** | [**ApiError**](ApiError.md) | Gets or sets inner error. | [optional]
2 changes: 1 addition & 1 deletion docs/ApiErrorResponse.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,4 @@ ApiError Response
Name | Type | Description | Notes
---- | ---- | ----------- | -----
**RequestId** | **string** | Gets or sets request Id. |
**Error** | [**ApiError**](ApiError.md) | |
**Error** | [**ApiError**](ApiError.md) | Gets or sets error. |
6 changes: 3 additions & 3 deletions docs/BarcodeImageParams.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,11 @@ Optional barcode image parameters.

Name | Type | Description | Notes
---- | ---- | ----------- | -----
**ImageFormat** | **BarcodeImageFormat** | | [optional]
**TextLocation** | **CodeLocation** | | [optional]
**ImageFormat** | **BarcodeImageFormat** | Barcode output image format. Default value: png. | [optional]
**TextLocation** | **CodeLocation** | Specify the displayed text location. Set to CodeLocation.None to hide CodeText. Default value depends on BarcodeType: CodeLocation.Below for 1D barcodes and CodeLocation.None for 2D barcodes. | [optional]
**ForegroundColor** | **string** | Specify the display color for bars and content. Value: Color name from https://reference.aspose.com/drawing/net/system.drawing/color/ or ARGB value starting with #. For example: AliceBlue or #FF000000. Default value: Black. | [optional] [default to "Black"]
**BackgroundColor** | **string** | Background color of the barcode image. Value: Color name from https://reference.aspose.com/drawing/net/system.drawing/color/ or ARGB value starting with #. For example: AliceBlue or #FF000000. Default value: White. | [optional] [default to "White"]
**Units** | **GraphicsUnit** | | [optional]
**Units** | **GraphicsUnit** | Common units for all measurements. Default units: pixels. | [optional]
**Resolution** | **float?** | Resolution of the barcode image. One value for both dimensions. Default value: 96 dpi. Decimal separator is a dot. | [optional]
**ImageHeight** | **float?** | Height of the barcode image in the specified units. Default units: pixels. Decimal separator is a dot. | [optional]
**ImageWidth** | **float?** | Width of the barcode image in the specified units. Default units: pixels. Decimal separator is a dot. | [optional]
Expand Down
2 changes: 1 addition & 1 deletion docs/Code128Params.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,4 @@ Optional Code128 barcode generation parameters.

Name | Type | Description | Notes
---- | ---- | ----------- | -----
**Code128EncodeMode** | **Code128EncodeMode** | | [optional]
**Code128EncodeMode** | **Code128EncodeMode** | Code128 barcode encode mode. Controls which Code 128 subset (A, B, C, or mix) is used. | [optional]
2 changes: 1 addition & 1 deletion docs/EncodeData.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,5 +6,5 @@ Data to encode in a barcode.

Name | Type | Description | Notes
---- | ---- | ----------- | -----
**DataType** | **EncodeDataType** | | [optional]
**DataType** | **EncodeDataType** | Type of data to encode. Default value: StringData. | [optional]
**Data** | **string** | String that represents the data to encode. |
32 changes: 16 additions & 16 deletions docs/GenerateApi.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,35 +99,35 @@ Generate a barcode using a POST request with parameters in a multipart form.

Name | Type | Description | Notes
---- | ---- | ------------ | -----
**barcodeType** | **EncodeBarcodeType**| |
**barcodeType** | **EncodeBarcodeType**| See https://reference.aspose.com/barcode/net/aspose.barcode.generation/encodetypes/ |
**data** | **string**| String that represents the data to encode. |
**dataType** | **EncodeDataType?**| | [optional]
**imageFormat** | **BarcodeImageFormat?**| | [optional]
**textLocation** | **CodeLocation?**| | [optional]
**dataType** | **EncodeDataType?**| Type of data to encode. Default value: StringData. | [optional]
**imageFormat** | **BarcodeImageFormat?**| Barcode output image format. Default value: png. | [optional]
**textLocation** | **CodeLocation?**| Specify the displayed text location. Set to CodeLocation.None to hide CodeText. Default value depends on BarcodeType: CodeLocation.Below for 1D barcodes and CodeLocation.None for 2D barcodes. | [optional]
**foregroundColor** | **string**| Specify the display color for bars and content. Value: Color name from https://reference.aspose.com/drawing/net/system.drawing/color/ or ARGB value starting with #. For example: AliceBlue or #FF000000. Default value: Black. | [optional] [default to "Black"]
**backgroundColor** | **string**| Background color of the barcode image. Value: Color name from https://reference.aspose.com/drawing/net/system.drawing/color/ or ARGB value starting with #. For example: AliceBlue or #FF000000. Default value: White. | [optional] [default to "White"]
**units** | **GraphicsUnit?**| | [optional]
**units** | **GraphicsUnit?**| Common units for all measurements. Default units: pixels. | [optional]
**resolution** | **float?**| Resolution of the barcode image. One value for both dimensions. Default value: 96 dpi. Decimal separator is a dot. | [optional]
**imageHeight** | **float?**| Height of the barcode image in the specified units. Default units: pixels. Decimal separator is a dot. | [optional]
**imageWidth** | **float?**| Width of the barcode image in the specified units. Default units: pixels. Decimal separator is a dot. | [optional]
**rotationAngle** | **int?**| Barcode image rotation angle, measured in degrees. For example, RotationAngle = 0 or RotationAngle = 360 means no rotation. If RotationAngle is not equal to 90, 180, 270, or 0, it may increase the difficulty for the scanner to read the image. Default value: 0. | [optional]
**qrEncodeMode** | **QREncodeMode?**| | [optional]
**qrErrorLevel** | **QRErrorLevel?**| | [optional]
**qrVersion** | **QRVersion?**| | [optional]
**qrECIEncoding** | **ECIEncodings?**| | [optional]
**qrEncodeMode** | **QREncodeMode?**| QR barcode encode mode. | [optional]
**qrErrorLevel** | **QRErrorLevel?**| QR barcode error correction level. | [optional]
**qrVersion** | **QRVersion?**| QR barcode version. Automatically selects the smallest version that fits the data. | [optional]
**qrECIEncoding** | **ECIEncodings?**| ECI encoding for QR barcode data. | [optional]
**qrAspectRatio** | **float?**| QR barcode aspect ratio. Values: 0 to 1. | [optional]
**microQRVersion** | **MicroQRVersion?**| | [optional]
**rectMicroQrVersion** | **RectMicroQRVersion?**| | [optional]
**code128EncodeMode** | **Code128EncodeMode?**| | [optional]
**pdf417EncodeMode** | **Pdf417EncodeMode?**| | [optional]
**pdf417ErrorLevel** | **Pdf417ErrorLevel?**| | [optional]
**microQRVersion** | **MicroQRVersion?**| MicroQR barcode version. Used when BarcodeType is MicroQR. | [optional]
**rectMicroQrVersion** | **RectMicroQRVersion?**| RectMicroQR barcode version. Used when BarcodeType is RectMicroQR. | [optional]
**code128EncodeMode** | **Code128EncodeMode?**| Code128 barcode encode mode. Controls which Code 128 subset (A, B, C, or mix) is used. | [optional]
**pdf417EncodeMode** | **Pdf417EncodeMode?**| PDF417 barcode encode mode. | [optional]
**pdf417ErrorLevel** | **Pdf417ErrorLevel?**| PDF417 barcode error correction level. | [optional]
**pdf417Truncate** | **bool?**| Whether to use truncated PDF417 format (removes right-side stop pattern). | [optional]
**pdf417Columns** | **int?**| Number of columns in the PDF417 barcode. Values between 1 and 30. 0 for auto. | [optional]
**pdf417Rows** | **int?**| Number of rows in the PDF417 barcode. Values between 3 and 90. 0 for automatic. | [optional]
**pdf417AspectRatio** | **float?**| PDF417 barcode aspect ratio (height/width of the barcode module). Values are defined by the standard: 2 to 5 for MicroPdf417; 3 to 5 for Pdf417 and MacroPdf417. | [optional]
**pdf417ECIEncoding** | **ECIEncodings?**| | [optional]
**pdf417ECIEncoding** | **ECIEncodings?**| ECI encoding for PDF417 barcode data. | [optional]
**pdf417IsReaderInitialization** | **bool?**| Whether the barcode is used for reader initialization (programming). | [optional]
**pdf417MacroCharacters** | **MacroCharacter?**| | [optional]
**pdf417MacroCharacters** | **MacroCharacter?**| Macro character to prepend (structured append). | [optional]
**pdf417IsLinked** | **bool?**| Whether to use linked mode (for MicroPdf417). | [optional]
**pdf417IsCode128Emulation** | **bool?**| Whether to use Code128 emulation for MicroPdf417. | [optional]

Expand Down
12 changes: 6 additions & 6 deletions docs/GenerateParams.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@ Barcode generation parameters.

Name | Type | Description | Notes
---- | ---- | ----------- | -----
**BarcodeType** | **EncodeBarcodeType** | |
**EncodeData** | [**EncodeData**](EncodeData.md) | |
**BarcodeImageParams** | [**BarcodeImageParams**](BarcodeImageParams.md) | | [optional]
**QrParams** | [**QrParams**](QrParams.md) | | [optional]
**Code128Params** | [**Code128Params**](Code128Params.md) | | [optional]
**Pdf417Params** | [**Pdf417Params**](Pdf417Params.md) | | [optional]
**BarcodeType** | **EncodeBarcodeType** | Barcode type. |
**EncodeData** | [**EncodeData**](EncodeData.md) | Data to encode into a barcode. |
**BarcodeImageParams** | [**BarcodeImageParams**](BarcodeImageParams.md) | Optional barcode image parameters. | [optional]
**QrParams** | [**QrParams**](QrParams.md) | Optional QR barcode generation parameters. | [optional]
**Code128Params** | [**Code128Params**](Code128Params.md) | Optional Code128 barcode generation parameters. | [optional]
**Pdf417Params** | [**Pdf417Params**](Pdf417Params.md) | Optional PDF417 barcode generation parameters. | [optional]
8 changes: 4 additions & 4 deletions docs/Pdf417Params.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,14 @@ Optional PDF417 barcode generation parameters. Applies to Pdf417, MacroPdf417, M

Name | Type | Description | Notes
---- | ---- | ----------- | -----
**Pdf417EncodeMode** | **Pdf417EncodeMode** | | [optional]
**Pdf417ErrorLevel** | **Pdf417ErrorLevel** | | [optional]
**Pdf417EncodeMode** | **Pdf417EncodeMode** | PDF417 barcode encode mode. | [optional]
**Pdf417ErrorLevel** | **Pdf417ErrorLevel** | PDF417 barcode error correction level. | [optional]
**Pdf417Truncate** | **bool?** | Whether to use truncated PDF417 format (removes right-side stop pattern). | [optional]
**Pdf417Columns** | **int?** | Number of columns in the PDF417 barcode. Values between 1 and 30. 0 for auto. | [optional]
**Pdf417Rows** | **int?** | Number of rows in the PDF417 barcode. Values between 3 and 90. 0 for automatic. | [optional]
**Pdf417AspectRatio** | **float?** | PDF417 barcode aspect ratio (height/width of the barcode module). Values are defined by the standard: 2 to 5 for MicroPdf417; 3 to 5 for Pdf417 and MacroPdf417. | [optional]
**Pdf417ECIEncoding** | **ECIEncodings** | | [optional]
**Pdf417ECIEncoding** | **ECIEncodings** | ECI encoding for PDF417 barcode data. | [optional]
**Pdf417IsReaderInitialization** | **bool?** | Whether the barcode is used for reader initialization (programming). | [optional]
**Pdf417MacroCharacters** | **MacroCharacter** | | [optional]
**Pdf417MacroCharacters** | **MacroCharacter** | Macro character to prepend (structured append). | [optional]
**Pdf417IsLinked** | **bool?** | Whether to use linked mode (for MicroPdf417). | [optional]
**Pdf417IsCode128Emulation** | **bool?** | Whether to use Code128 emulation for MicroPdf417. | [optional]
12 changes: 6 additions & 6 deletions docs/QrParams.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,10 @@ Optional QR barcode generation parameters. Applies to QR, GS1QR, MicroQR, and Re

Name | Type | Description | Notes
---- | ---- | ----------- | -----
**QrEncodeMode** | **QREncodeMode** | | [optional]
**QrErrorLevel** | **QRErrorLevel** | | [optional]
**QrVersion** | **QRVersion** | | [optional]
**QrECIEncoding** | **ECIEncodings** | | [optional]
**QrEncodeMode** | **QREncodeMode** | QR barcode encode mode. | [optional]
**QrErrorLevel** | **QRErrorLevel** | QR barcode error correction level. | [optional]
**QrVersion** | **QRVersion** | QR barcode version. Automatically selects the smallest version that fits the data. | [optional]
**QrECIEncoding** | **ECIEncodings** | ECI encoding for QR barcode data. | [optional]
**QrAspectRatio** | **float?** | QR barcode aspect ratio. Values: 0 to 1. | [optional]
**MicroQRVersion** | **MicroQRVersion** | | [optional]
**RectMicroQrVersion** | **RectMicroQRVersion** | | [optional]
**MicroQRVersion** | **MicroQRVersion** | MicroQR barcode version. Used when BarcodeType is MicroQR. | [optional]
**RectMicroQrVersion** | **RectMicroQRVersion** | RectMicroQR barcode version. Used when BarcodeType is RectMicroQR. | [optional]
6 changes: 3 additions & 3 deletions docs/RecognizeApi.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,10 +72,10 @@ Recognize a barcode from a file in the request body using a POST request with mu

Name | Type | Description | Notes
---- | ---- | ------------ | -----
**barcodeType** | **DecodeBarcodeType**| |
**barcodeType** | **DecodeBarcodeType**| See https://reference.aspose.com/barcode/net/aspose.barcode.barcoderecognition/decodetype/ |
**file** | **System.IO.Stream****System.IO.Stream**| Barcode image file. |
**recognitionMode** | **RecognitionMode?**| | [optional]
**recognitionImageKind** | **RecognitionImageKind?**| | [optional]
**recognitionMode** | **RecognitionMode?**| Recognition mode. | [optional]
**recognitionImageKind** | **RecognitionImageKind?**| Image kind for recognition. | [optional]

### Return type

Expand Down
4 changes: 2 additions & 2 deletions docs/RecognizeBase64Request.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,5 +8,5 @@ Name | Type | Description | Notes
---- | ---- | ----------- | -----
**BarcodeTypes** | [**List<DecodeBarcodeType>**](DecodeBarcodeType.md) | Array of barcode decode types to find. |
**FileBase64** | **string** | Barcode image bytes encoded as base-64. |
**RecognitionMode** | **RecognitionMode** | | [optional]
**RecognitionImageKind** | **RecognitionImageKind** | | [optional]
**RecognitionMode** | **RecognitionMode** | Barcode recognition mode. | [optional]
**RecognitionImageKind** | **RecognitionImageKind** | Image kind for recognition. | [optional]
Loading