Skip to content

Commit c5dd375

Browse files
committed
Update api.md
1 parent 40d344b commit c5dd375

File tree

1 file changed

+6
-5
lines changed

1 file changed

+6
-5
lines changed

docs/api.md

+6-5
Original file line numberDiff line numberDiff line change
@@ -2344,24 +2344,25 @@ PIN : String with the PIN number to check
23442344
#### Returns
23452345
int : Returns 0 if the PIN is valid, returns -1 if it is not.
23462346

2347-
### `checkPIN()`
2347+
### `checkPUK()`
23482348

23492349
#### Description
23502350

2351-
Queries the SIM card with a PIN number to see if it is valid.
2351+
Queries the SIM card with a PUK and PIN number to see if it is valid.
23522352

23532353
#### Syntax
23542354

23552355
```
2356-
pin.checkPIN(PIN)
2356+
pin.checkPIN(PUK, PIN)
23572357
23582358
```
23592359

23602360
#### Parameters
2361-
PIN : String with the PIN number to check
2361+
- PIN : String with the PIN number to check
2362+
- PUK : String with the PUK number to check
23622363

23632364
#### Returns
2364-
int : Returns 0 if the PIN is valid, returns -1 if it is not.
2365+
int : Returns 0 if it is valid, returns -1 if it is not.
23652366

23662367
### `changePIN()`
23672368

0 commit comments

Comments
 (0)