-
Notifications
You must be signed in to change notification settings - Fork 12
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
adding realtime update to all server-side sdk docs #770
base: main
Are you sure you want to change the base?
Conversation
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
@@ -56,9 +56,9 @@ namespace Example { | |||
``` | |||
[//]: # (wizard-initialize-end) | |||
|
|||
### Initialization With Callback | |||
## Initialization Options |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We specifically want to call out that this example below is with a callback - and will not block on returning an initialized sdk.
| logger | DevCycleLogger | Logger override to replace default logger | | ||
| logLevel | String | Set log level of the default logger. Options are: `debug`, `info`, `warn`, `error`. Defaults to `info`. | | ||
| enableCloudBucketing | Boolean | Switches the SDK to use Cloud Bucketing (via the DevCycle Bucketing API) instead of Local Bucketing. | | ||
| enableEdgeDB | Boolean | Enables the usage of EdgeDB for DevCycle that syncs User Data to DevCycle. <br />NOTE: This is only available with Cloud Bucketing. | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| enableEdgeDB | Boolean | Enables the usage of EdgeDB for DevCycle that syncs User Data to DevCycle. <br />NOTE: This is only available with Cloud Bucketing. | | |
| enableEdgeDB | Boolean | Enables the usage of EdgeDB for DevCycle that syncs User Data to DevCycle. <br />NOTE: This is only available with Cloud Bucketing enabled. | |
| logLevel | String | Set log level of the default logger. Options are: `debug`, `info`, `warn`, `error`. Defaults to `info`. | | ||
| enableCloudBucketing | Boolean | Switches the SDK to use Cloud Bucketing (via the DevCycle Bucketing API) instead of Local Bucketing. | | ||
| enableEdgeDB | Boolean | Enables the usage of EdgeDB for DevCycle that syncs User Data to DevCycle. <br />NOTE: This is only available with Cloud Bucketing. | | ||
| configPollingIntervalMS | Number | Controls the polling interval in milliseconds to fetch new environment config changes, defaults to 10 seconds, minimum value is 1 second. | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
These datatypes are wrong for C# - "Number" isn't correct.
| logLevel | String | Set log level of the default logger. Options are: `debug`, `info`, `warn`, `error`. Defaults to `info`. | | ||
| enableCloudBucketing | Boolean | Switches the SDK to use Cloud Bucketing (via the DevCycle Bucketing API) instead of Local Bucketing. | | ||
| enableEdgeDB | Boolean | Enables the usage of EdgeDB for DevCycle that syncs User Data to DevCycle. <br />NOTE: This is only available with Cloud Bucketing. | | ||
| configPollingIntervalMS | Number | Controls the polling interval in milliseconds to fetch new environment config changes, defaults to 10 seconds, minimum value is 1 second. | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Same comment here on the datatypes.
| logger | DevCycleLogger | Logger override to replace default logger | | ||
| logLevel | String | Set log level of the default logger. Options are: `debug`, `info`, `warn`, `error`. Defaults to `info`. | | ||
| enableCloudBucketing | Boolean | Switches the SDK to use Cloud Bucketing (via the DevCycle Bucketing API) instead of Local Bucketing. | | ||
| enableEdgeDB | Boolean | Enables the usage of EdgeDB for DevCycle that syncs User Data to DevCycle. <br />NOTE: This is only available with Cloud Bucketing. | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| enableEdgeDB | Boolean | Enables the usage of EdgeDB for DevCycle that syncs User Data to DevCycle. <br />NOTE: This is only available with Cloud Bucketing. | | |
| enableEdgeDB | Boolean | Enables the usage of EdgeDB for DevCycle that syncs User Data to DevCycle. <br />NOTE: This is only available with Cloud Bucketing enabled. | |
|
||
public MyClass() { | ||
DevCycleLocalOptions options = DevCycleLocalOptions.builder() | ||
.enableBetaRealtimeUpdates(true) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
|
||
To enable Beta Realtime Updates, pass in the `enableBetaRealtimeUpdates` option to the SDK initialization: | ||
|
||
```csharp |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
use a long-lived HTTP connection (Server Sent Events) to receive updates when there is a new config available. | ||
This reduces outbound network traffic, as well as optimizes the SDK for efficiency. | ||
|
||
To enable Beta Realtime Updates, pass in the `enableBetaRealtimeUpdates` option to the SDK initialization: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
devcycle_client = DevCycleCloudClient(os.environ["DEVCYCLE_SERVER_SDK_KEY"], options) | ||
``` | ||
|
||
| DevCycle Option | Type | Description | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
|
||
To enable Beta Realtime Updates, pass in the `enableBetaRealtimeUpdates` option to the SDK initialization: | ||
|
||
```ruby |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
No description provided.