Improve React Native SDK description #326
Conversation
| * Enable biometric authentication for the signed in user. | ||
| * Platform specific biometric authentication UI will be shown. | ||
| * You may first enable biometric authentication in Authgear Portal (Your Project \> Authentication \> Biometric \> Enable biometric authentication). | ||
| * Otherwise, `BiometricDisallowed` error will be thrown. |
There was a problem hiding this comment.
We do not have BiometricDisallowed error. Remove this line.
| * Authenticate with biometric authentication. | ||
| * Platform specific biometric authentication UI will be shown. | ||
| * You may first enable biometric authentication in Authgear Portal (Your Project \> Authentication \> Biometric \> Enable biometric authentication). | ||
| * Otherwise, `BiometricDisallowed` error will be thrown. |
There was a problem hiding this comment.
We do not have BiometricDisallowed error. Remove this line.
| /* | ||
| * The URL to open. | ||
| /** | ||
| * The target authorization URL. | ||
| */ |
There was a problem hiding this comment.
Change the description to The URL to be opened by the UIImplementation.
This documentation is for UIImplementation implementor. So from their point of view, they want to know how to implement a UIImplementation. The documentation should guide them.
| * The URL to detect. | ||
| /** | ||
| * The value should be a valid Redirect URI to which the response will be sent after authentication. | ||
| * You must also add a Redirect URI in Authgear Poral via the Redirect URI section of your Authgear Application. | ||
| */ |
There was a problem hiding this comment.
Change the description to The URL to be detected by the UIImplementation. When this URL is detected, the UIImplementation MUST return this URL, and close itself.
| * A flag to some implementations that can share cookies with the device browser. | ||
| * When it is set to true, cookies will be shared with the device browser. |
There was a problem hiding this comment.
Change the description to A flag to tell the UIImplementation that cookies should be shared with the device browser. This flag is only useful to UIImplementation that can share cookies with the device browser, such as those underlying implementations are based ASWebAuthenticationSession, or CustomTabs.
andychow326
force-pushed
the
2040-react-native-docs
branch
from
07b63cf to
f624786
Compare
|
@louischan-oursky Updated! :adore2x: |
ref DEV-2040