Skip to content

Commit b9e60f8

Browse files
committed
docs: update readme
1 parent 4589f2c commit b9e60f8

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -233,7 +233,7 @@ To handle authentication in a React Native app you can either use the AccountsSD
233233

234234
The `useIgnite` hook implements all of the native Accounts SDK methods for easy out of the box use in a React Native apps. It also provides `isLoggingIn` and an `authState` object with properties `isLoggedIn`, `memberInfo` and `isConfigured`, these properties update themselves during and after authenticaion.
235235

236-
Once the user authenticates `isLoggedIn` will remain true after app restarts
236+
Once the user authenticates `isLoggedIn` will remain true after app restarts. On the initial render, `isLoggedIn` is `false` and is updated to `true` when the login state is retrieved from the native SDK's. To avoid an incorrect logged out state on the first render, on your apps home screens you can hide sign in text/UI or use an `<ActivityIndicator />`/loading UI in that area of the screen while `isConfigured` is false.
237237

238238
`isConfigured` becomes true after the Accounts SDK has successfully configured and the local storage `isLoggedIn` value and `memberInfo` response data have both been retrieved by the SDK. This makes it useful to condition against any API calls which require OAuth tokens or any UI buttons that trigger Ignite SDK views and methods, as if the Accounts SDK does not configure, auth will not work in any of the SDK's and API calls that require OAuth tokens will fail.
239239

@@ -341,7 +341,7 @@ Exposes the following functions:
341341
- `configureAccountsSDK` - Called in `IgniteProvider` before `<App />` is mounted, generally no need to implement this method manually.
342342
- `login`
343343
- `logout`
344-
- `logoutAll`
344+
- `logoutAll` - iOS only
345345
- `refreshToken`
346346
- `getMemberInfo`
347347
- `getToken`

0 commit comments

Comments
 (0)