Skip to content

Commit

Permalink
Update android sdk onClientReady hook with ClientReadyState parameter (
Browse files Browse the repository at this point in the history
…#450)

* Update android sdk onClientReady hook with ClientReadyState parameter

* Updates based on review.

* Update website/docs/sdk-reference/android.mdx

Fix state name

Co-authored-by: adams85 <[email protected]>

---------

Co-authored-by: adams85 <[email protected]>
  • Loading branch information
novalisdenahi and adams85 authored Jun 14, 2024
1 parent da6ac26 commit 991f82e
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion website/docs/sdk-reference/android.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -421,7 +421,7 @@ client.forceRefresh();

With the following hooks you can subscribe to particular events fired by the SDK:

- `onClientReady()`: This event is sent when the SDK reaches the ready state. If the SDK is configured with lazy load or manual polling it's considered ready right after instantiation.
- `onClientReady(ClientCacheState)`: This event is sent when the SDK reaches the ready state. If the SDK is set up to use lazy loading or manual polling, it's considered ready right after syncing up with the config cache.
If it's using auto polling, the ready state is reached when the SDK has a valid config JSON loaded into memory either from cache or from HTTP. If the config couldn't be loaded neither from cache nor from HTTP the `onClientReady` event fires when the auto polling's `maxInitWaitTimeSeconds` is reached.

- `onConfigChanged(Map<String, Setting>)`: This event is sent when the SDK loads a valid config JSON into memory from cache, and each subsequent time when the loaded config JSON changes via HTTP.
Expand Down

0 comments on commit 991f82e

Please sign in to comment.