Skip to content

Commit

Permalink
doc for getPincodeInfo, getProfileImage and startProfileImageFlow
Browse files Browse the repository at this point in the history
  • Loading branch information
atabel committed Mar 6, 2024
1 parent 3607d19 commit 4653c3b
Showing 1 changed file with 43 additions and 0 deletions.
43 changes: 43 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -1023,6 +1023,49 @@ getNetworkConnectionInfo: () => Promise<{
- `mobileSignalStrength`: gives a measure of the current signal strength for
'MOBILE' connectionType.
### getPincodeInfo
<kbd>App version >=24.2</kbd>
Check if the pincode is enabled or not
```ts
getPincodeInfo: () => Promise<{
status: 'enabled' | 'disabled'
}>;
```
### getProfileImage
<kbd>App version >=14.9</kbd>
Read current profile picture
```ts
getProfileImage: () => Promise<{
image: 'string' | null
}>;
```
- `image`: base64 encoded image or null if there is no image
### startProfileImageFlow
<kbd>App version >=14.9</kbd>
Starts the native flow to change the profile picture
```ts
startProfileImageFlow: () => Promise<{
image: string | null;
isCancelled: boolean;
}>;
```
- `image`: base64 encoded image or null if the image was removed or the flow
cancelled
- `isCancelled`: true if the user cancelled the flow
## Error handling
If an uncontrolled error occurs, promise will be rejected with an error object:
Expand Down

0 comments on commit 4653c3b

Please sign in to comment.