From 4653c3b901f3ddcde04f6a8fece1a0bfa7b05afe Mon Sep 17 00:00:00 2001 From: Abel Toledano Date: Wed, 6 Mar 2024 16:20:23 +0100 Subject: [PATCH] doc for getPincodeInfo, getProfileImage and startProfileImageFlow --- README.md | 43 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 43 insertions(+) diff --git a/README.md b/README.md index 927d268..4b22f64 100644 --- a/README.md +++ b/README.md @@ -1023,6 +1023,49 @@ getNetworkConnectionInfo: () => Promise<{ - `mobileSignalStrength`: gives a measure of the current signal strength for 'MOBILE' connectionType. +### getPincodeInfo + +App version >=24.2 + +Check if the pincode is enabled or not + +```ts +getPincodeInfo: () => Promise<{ + status: 'enabled' | 'disabled' +}>; +``` + +### getProfileImage + +App version >=14.9 + +Read current profile picture + +```ts +getProfileImage: () => Promise<{ + image: 'string' | null +}>; +``` + +- `image`: base64 encoded image or null if there is no image + +### startProfileImageFlow + +App version >=14.9 + +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: