marcogll/passkit-generator
1
0
Fork 0
mirror of https://github.com/marcogll/passkit-generator.git synced 2026-03-15 18:25:24 +00:00
Code Issues Packages Projects Releases Wiki Activity

Improved text and descriptions in API document

Browse Source
This commit is contained in:
alexandercerutti
2018-10-07 21:00:29 +02:00
parent 4f380492c6
commit 188b35570c
1 changed files with 13 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
API.md
View File

@@ -9,7 +9,7 @@ The flow of execution is really easy (once setted-up everything):
Some details:
* Every schema the properties will be checked against, is built to reflect Apple's specifications, that can be found on Apple Developer Portal, at [PassKit Package Format Reference](https://apple.co/2MUHsm0).
* Properties will be checked against schemas, which are built to reflect Apple's specifications, that can be found on Apple Developer Portal, at [PassKit Package Format Reference](https://apple.co/2MUHsm0).
* Here below are listed all the available methods that library will let you use.
@@ -218,8 +218,8 @@ pass.barcode(data).backward(format);
**Description**:
Will let you choose the format to be used in barcode property as backward compatibility.
Also will only work if `data` is provided to `barcode()` method and will fail if the selected format is not found among barcodes dictionaries array.
It will let you choose the format to be used in barcode property as backward compatibility.
Also it will work only if `data` is provided to `barcode()` method and will fail if the selected format is not found among barcodes dictionaries array.
**Arguments**:
@@ -256,7 +256,7 @@ pass.barcode(data).autocomplete();
**Description**:
Will generate all the barcodes fallback starting from the first dictionary in `barcodes`.
It will generate all the barcodes fallback starting from the first dictionary in `barcodes`.
<br><br>
___
@@ -309,7 +309,7 @@ pass.void();
**Description**:
Sets directly the pass as voided (void: true).
It sets directly the pass as voided (void: true).
<br><br>
___