Skip to content

Commit 11db3c5

Browse files
Denis-AverinDenis-Averin
authored
Merge pull request #3 from aspose-barcode-cloud/release-26.6
Fix documentation
2 parents d918aca + 8c870d5 commit 11db3c5

4 files changed

Lines changed: 37 additions & 172 deletions

File tree

‎Sources/AsposeBarcodeCloud/APIs/GenerateAPI.swift‎

Lines changed: 11 additions & 56 deletions
Original file line numberDiff line numberDiff line change
@@ -56,37 +56,14 @@ open class GenerateAPI {
5656
- OAuth:
5757
- type: oauth2
5858
- name: JWT
59+
5960
- parameter barcodeType: (path) Type of barcode to generate.
6061
- parameter data: (query) String that represents the data to encode.
6162
- parameter dataType: (query) Type of data to encode. Default value: StringData. (optional)
62-
- parameter imageFormat: (query) Barcode output image format. Default value: png. (optional)
63-
- parameter textLocation: (query) 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)
64-
- parameter foregroundColor: (query) 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")
65-
- parameter backgroundColor: (query) 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")
66-
- parameter units: (query) Common units for all measurements. Default units: pixels. (optional)
67-
- parameter resolution: (query) Resolution of the barcode image. One value for both dimensions. Default value: 96 dpi. Decimal separator is a dot. (optional)
68-
- parameter imageHeight: (query) Height of the barcode image in the specified units. Default units: pixels. Decimal separator is a dot. (optional)
69-
- parameter imageWidth: (query) Width of the barcode image in the specified units. Default units: pixels. Decimal separator is a dot. (optional)
70-
- parameter rotationAngle: (query) 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)
71-
- parameter qrEncodeMode: (query) QR barcode encode mode. (optional)
72-
- parameter qrErrorLevel: (query) QR barcode error correction level. (optional)
73-
- parameter qrVersion: (query) QR barcode version. Automatically selects the smallest version that fits the data. (optional)
74-
- parameter qrECIEncoding: (query) ECI encoding for QR barcode data. (optional)
75-
- parameter qrAspectRatio: (query) QR barcode aspect ratio. Values: 0 to 1. (optional)
76-
- parameter microQRVersion: (query) MicroQR barcode version. Used when BarcodeType is MicroQR. (optional)
77-
- parameter rectMicroQrVersion: (query) RectMicroQR barcode version. Used when BarcodeType is RectMicroQR. (optional)
78-
- parameter code128EncodeMode: (query) Code128 barcode encode mode. Controls which Code 128 subset (A, B, C, or mix) is used. (optional)
79-
- parameter pdf417EncodeMode: (query) PDF417 barcode encode mode. (optional)
80-
- parameter pdf417ErrorLevel: (query) PDF417 barcode error correction level. (optional)
81-
- parameter pdf417Truncate: (query) Whether to use truncated PDF417 format (removes right-side stop pattern). (optional)
82-
- parameter pdf417Columns: (query) Number of columns in the PDF417 barcode. Values between 1 and 30. 0 for auto. (optional)
83-
- parameter pdf417Rows: (query) Number of rows in the PDF417 barcode. Values between 3 and 90. 0 for automatic. (optional)
84-
- parameter pdf417AspectRatio: (query) 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)
85-
- parameter pdf417ECIEncoding: (query) ECI encoding for PDF417 barcode data. (optional)
86-
- parameter pdf417IsReaderInitialization: (query) Whether the barcode is used for reader initialization (programming). (optional)
87-
- parameter pdf417MacroCharacters: (query) Macro character to prepend (structured append). (optional)
88-
- parameter pdf417IsLinked: (query) Whether to use linked mode (for MicroPdf417). (optional)
89-
- parameter pdf417IsCode128Emulation: (query) Whether to use Code128 emulation for MicroPdf417. (optional)
63+
- parameter barcodeImageParams: (BarcodeImageParams) Grouped barcodeImageParams parameters.
64+
- parameter qrParams: (QrParams) Grouped qrParams parameters.
65+
- parameter code128Params: (Code128Params) Grouped code128Params parameters.
66+
- parameter pdf417Params: (Pdf417Params) Grouped pdf417Params parameters.
9067
- parameter apiConfiguration: The configuration for the http request.
9168
- returns: RequestBuilder<Data>
9269
*/
@@ -177,6 +154,7 @@ open class GenerateAPI {
177154
- OAuth:
178155
- type: oauth2
179156
- name: JWT
157+
180158
- parameter generateParams: (body) Generation parameters.
181159
- parameter apiConfiguration: The configuration for the http request.
182160
- returns: RequestBuilder<Data>
@@ -247,37 +225,14 @@ open class GenerateAPI {
247225
- OAuth:
248226
- type: oauth2
249227
- name: JWT
228+
250229
- parameter barcodeType: (form) See https://reference.aspose.com/barcode/net/aspose.barcode.generation/encodetypes/
251230
- parameter data: (form) String that represents the data to encode.
252231
- parameter dataType: (form) Type of data to encode. Default value: StringData. (optional)
253-
- parameter imageFormat: (form) Barcode output image format. Default value: png. (optional)
254-
- parameter textLocation: (form) 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)
255-
- parameter foregroundColor: (form) 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")
256-
- parameter backgroundColor: (form) 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")
257-
- parameter units: (form) Common units for all measurements. Default units: pixels. (optional)
258-
- parameter resolution: (form) Resolution of the barcode image. One value for both dimensions. Default value: 96 dpi. Decimal separator is a dot. (optional)
259-
- parameter imageHeight: (form) Height of the barcode image in the specified units. Default units: pixels. Decimal separator is a dot. (optional)
260-
- parameter imageWidth: (form) Width of the barcode image in the specified units. Default units: pixels. Decimal separator is a dot. (optional)
261-
- parameter rotationAngle: (form) Barcode image rotation angle, measured in degrees. For example, RotationAngle &#x3D; 0 or RotationAngle &#x3D; 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)
262-
- parameter qrEncodeMode: (form) QR barcode encode mode. (optional)
263-
- parameter qrErrorLevel: (form) QR barcode error correction level. (optional)
264-
- parameter qrVersion: (form) QR barcode version. Automatically selects the smallest version that fits the data. (optional)
265-
- parameter qrECIEncoding: (form) ECI encoding for QR barcode data. (optional)
266-
- parameter qrAspectRatio: (form) QR barcode aspect ratio. Values: 0 to 1. (optional)
267-
- parameter microQRVersion: (form) MicroQR barcode version. Used when BarcodeType is MicroQR. (optional)
268-
- parameter rectMicroQrVersion: (form) RectMicroQR barcode version. Used when BarcodeType is RectMicroQR. (optional)
269-
- parameter code128EncodeMode: (form) Code128 barcode encode mode. Controls which Code 128 subset (A, B, C, or mix) is used. (optional)
270-
- parameter pdf417EncodeMode: (form) PDF417 barcode encode mode. (optional)
271-
- parameter pdf417ErrorLevel: (form) PDF417 barcode error correction level. (optional)
272-
- parameter pdf417Truncate: (form) Whether to use truncated PDF417 format (removes right-side stop pattern). (optional)
273-
- parameter pdf417Columns: (form) Number of columns in the PDF417 barcode. Values between 1 and 30. 0 for auto. (optional)
274-
- parameter pdf417Rows: (form) Number of rows in the PDF417 barcode. Values between 3 and 90. 0 for automatic. (optional)
275-
- parameter pdf417AspectRatio: (form) 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)
276-
- parameter pdf417ECIEncoding: (form) ECI encoding for PDF417 barcode data. (optional)
277-
- parameter pdf417IsReaderInitialization: (form) Whether the barcode is used for reader initialization (programming). (optional)
278-
- parameter pdf417MacroCharacters: (form) Macro character to prepend (structured append). (optional)
279-
- parameter pdf417IsLinked: (form) Whether to use linked mode (for MicroPdf417). (optional)
280-
- parameter pdf417IsCode128Emulation: (form) Whether to use Code128 emulation for MicroPdf417. (optional)
232+
- parameter barcodeImageParams: (BarcodeImageParams) Grouped barcodeImageParams parameters.
233+
- parameter qrParams: (QrParams) Grouped qrParams parameters.
234+
- parameter code128Params: (Code128Params) Grouped code128Params parameters.
235+
- parameter pdf417Params: (Pdf417Params) Grouped pdf417Params parameters.
281236
- parameter apiConfiguration: The configuration for the http request.
282237
- returns: RequestBuilder<Data>
283238
*/

‎Sources/AsposeBarcodeCloud/APIs/RecognizeAPI.swift‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,7 @@ open class RecognizeAPI {
5050
- OAuth:
5151
- type: oauth2
5252
- name: JWT
53+
5354
- parameter barcodeType: (query) Type of barcode to recognize.
5455
- parameter fileUrl: (query) URL to the barcode image.
5556
- parameter recognitionMode: (query) Recognition mode. (optional)
@@ -115,6 +116,7 @@ open class RecognizeAPI {
115116
- OAuth:
116117
- type: oauth2
117118
- name: JWT
119+
118120
- parameter recognizeBase64Request: (body) Barcode recognition request.
119121
- parameter apiConfiguration: The configuration for the http request.
120122
- returns: RequestBuilder<BarcodeResponseList>
@@ -179,6 +181,7 @@ open class RecognizeAPI {
179181
- OAuth:
180182
- type: oauth2
181183
- name: JWT
184+
182185
- parameter barcodeType: (form) See https://reference.aspose.com/barcode/net/aspose.barcode.barcoderecognition/decodetype/
183186
- parameter file: (form) Barcode image file.
184187
- parameter recognitionMode: (form) Recognition mode. (optional)

‎Sources/AsposeBarcodeCloud/APIs/ScanAPI.swift‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,7 @@ open class ScanAPI {
4444
- OAuth:
4545
- type: oauth2
4646
- name: JWT
47+
4748
- parameter fileUrl: (query) URL to the barcode image.
4849
- parameter apiConfiguration: The configuration for the http request.
4950
- returns: RequestBuilder<BarcodeResponseList>
@@ -103,6 +104,7 @@ open class ScanAPI {
103104
- OAuth:
104105
- type: oauth2
105106
- name: JWT
107+
106108
- parameter scanBase64Request: (body) Barcode scan request.
107109
- parameter apiConfiguration: The configuration for the http request.
108110
- returns: RequestBuilder<BarcodeResponseList>
@@ -161,6 +163,7 @@ open class ScanAPI {
161163
- OAuth:
162164
- type: oauth2
163165
- name: JWT
166+
164167
- parameter file: (form) Barcode image file.
165168
- parameter apiConfiguration: The configuration for the http request.
166169
- returns: RequestBuilder<BarcodeResponseList>

0 commit comments

Comments
 (0)