mirror/Android
1
0
Fork 0
mirror of https://github.com/CatimaLoyalty/Android.git synced 2026-03-02 06:06:24 -05:00
Code Issues Packages Projects Releases Wiki Activity

Update docs

Browse Source
This commit is contained in:
Sylvia van Os
2026-01-13 20:14:57 +01:00
parent c9a2a4acbb
commit d3bdad56e4
2 changed files with 5 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/CARD_FIELDS.md
View File

@@ -15,7 +15,7 @@ An [export](./EXPORT_FORMAT.md) always contains all values. A [card sharing URL]
| cardid | Required | Any string | The loyalty card ID |
| barcodeid | Optional | Any string | The value of the loyalty card barcode, if different from the loyalty card ID |
| barcodetype | Optional | AZTEC, CODABAR, CODE_39, CODE_93, CODE_128, DATA_MATRIX, EAN_8, EAN_13, ITF, MAXICODE, PDF_417, QR_CODE, RSS_14, RSS_EXPANDED, UPC_A, UPC_E | The type of loyalty card barcode used |
| barcodeencoding | Optional | Either `null` (automatic detection using zxing's `guessEncoding` function) or any [StandardCharset](https://developer.android.com/reference/java/nio/charset/StandardCharsets)'s `.name()` output. Only `ISO-8859-1` and `UTF-8` are user selectable | The encoding used to render the loyalty card barcode |
| barcodeencoding | Optional | Any [StandardCharset](https://developer.android.com/reference/java/nio/charset/StandardCharsets)'s `.name()` output. Only `ISO-8859-1` and `UTF-8` are user selectable | The encoding used to render the loyalty card barcode |
| headercolor | Optional | A valid Android color value (https://developer.android.com/reference/android/graphics/Color) | The color to use in the header and card background |
| starstatus | Ignored | 0,1 | If the card is "starred" |
| lastused | Ignored | Any UNIX timestamp | When the loyalty card was last opened |

8
docs/EXPORT_FORMAT.md
View File

@@ -37,10 +37,10 @@ Food
Fashion
_id,store,note,validfrom,expiry,balance,balancetype,cardid,barcodeid,barcodetype,barcodeencoding,headercolor,starstatus,lastused,archive
1,Clothing Store,Note about store,,,0,,qw,,,,-45147,1,1730493938,0
2,Department Store,,,,0,,A,,,,-1499549,0,1730493491,0
3,Grocery Store,,,1453633200000,50,,dhd,,,,-11751600,0,1730493369,0
4,Pharmacy,,,,0,,dhshsvshs,,,,-16766866,0,1684347330,1
1,Clothing Store,Note about store,,,0,,qw,,,ISO-8859-1,-45147,1,1730493938,0
2,Department Store,,,,0,,A,,,ISO-8859-1,-1499549,0,1730493491,0
3,Grocery Store,,,1453633200000,50,,dhd,,,UTF-8,-11751600,0,1730493369,0
4,Pharmacy,,,,0,,dhshsvshs,,,ISO-8859-1,-16766866,0,1684347330,1
5,Restaurant,Note about restaurant here,,,0,,98765432,,CODE_128,UTF-8,-10902850,0,1730493357,0
6,Shoe Store,,,,0,,zhxbx,,AZTEC,ISO-8859-1,-6543440,0,1684347744,0