Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/sdk/client-side-sdks/android/android-gettingstarted.md
Original file line number Diff line number Diff line change
Expand Up @@ -119,8 +119,8 @@ The SDK exposes various initialization options which can be used by passing a `D
| configCacheTTL | Long | 2592000000 | The maximum allowed age of a cached config in milliseconds, defaults to 30 days |
| disableConfigCache | Boolean | false | Disable the use of cached configs |
| disableRealtimeUpdates | Boolean | false | Disable Realtime Updates |
| apiProxyURL | String | null | Allows the SDK to communicate with a proxy of DevCycle Client SDK API. |
| eventsApiProxyURL | String | null | Allows the SDK to communicate with a proxy of DevCycle Events API. |
| apiProxyUrl | String | null | Allows the SDK to communicate with a proxy of DevCycle Client SDK API. |
| eventsApiProxyUrl | String | null | Allows the SDK to communicate with a proxy of DevCycle Events API. |

## Notifying when DevCycle features are available

Expand Down
6 changes: 3 additions & 3 deletions docs/sdk/client-side-sdks/android/android-usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -250,7 +250,7 @@ DevCycleEvent event = DevCycleEvent.builder()
devcycleClient.track(event);
```

The SDK will flush events every 10s or `flushEventsMS` specified in the options.
The SDK will flush events every 10s or `flushEventsIntervalMs` specified in the options.

**Manually Flushing Events**

Expand Down Expand Up @@ -294,9 +294,9 @@ devcycleClient.flushEvents(new DevCycleCallback<String>() {

## EdgeDB

EdgeDB allows you to save user data to our EdgeDB storage so that you don't have to pass in all the user data every time you identify a user. Read more about [EdgeDB](/platform/feature-flags/targeting/edgedb).
EdgeDB allows you to save user data to our EdgeDB storage so that you don't have to pass in all the user data every time you identify a user.

To get started, contact us at support@devcycle.com to enable EdgeDB for your project.
To get started, enable EdgeDB on your project by following the guide [here](/platform/feature-flags/targeting/edgedb).

Once you have EdgeDB enabled in your project, pass in the enableEdgeDB option to turn on EdgeDB mode for the SDK:

Expand Down
7 changes: 4 additions & 3 deletions docs/sdk/client-side-sdks/angular/angular-gettingstarted.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ const devCycleProvider = new DevCycleAngularProvider(
{ /* DevCycle Options */ }
);

// A `targetingKey` or `user_id` is required to initialize the DevCycle Provider.
// Provide a `targetingKey` or `user_id` to avoid an anonymous user.
OpenFeature.setContext({
targetingKey: "user123"
});
Expand All @@ -52,9 +52,10 @@ It's best to initialize DevCycle in your root module, so that it can be initiali

:::

### Required TargetingKey
### TargetingKey or user_id

For DevCycle SDK to work we require either a `targetingKey` or `user_id` to be set on the OpenFeature context. This is used to identify the user as the user_id for a DevCycleUser in DevCycle.
DevCycle recommends setting a `targetingKey` or `user_id` on the OpenFeature context to identify the user.
If neither is set, the provider initializes an anonymous user and evaluates flags for that anonymous user.


### Context properties to DevCycleUser
Expand Down
5 changes: 2 additions & 3 deletions docs/sdk/client-side-sdks/flutter/flutter-usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -145,7 +145,7 @@ DevCycleEvent event = DevCycleEventBuilder()
_devcycleClient.track(event);
```

The SDK will flush events every 10s or `flushEventsMS` specified in the options. To manually flush events, call:
The SDK will flush events every 10s or `flushEventsIntervalMs` specified in the options. To manually flush events, call:

```dart
_devcycleClient.flushEvents();
Expand All @@ -162,9 +162,8 @@ _devcycleClient.flushEvents(([error]) => {
## EdgeDB

EdgeDB allows you to save user data to our EdgeDB storage so that you don't have to pass in all the user data every time you identify a user.
Read more about [EdgeDB](/platform/feature-flags/targeting/edgedb).

To get started, contact us at support@devcycle.com to enable EdgeDB for your project.
To get started, enable EdgeDB on your project by following the guide [here](/platform/feature-flags/targeting/edgedb).

Once you have EdgeDB enabled in your project, pass in the enableEdgeDB option to turn on EdgeDB mode for the SDK:

Expand Down
2 changes: 1 addition & 1 deletion docs/sdk/client-side-sdks/ios/ios-gettingstarted.md
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,7 @@ The SDK exposes various initialization options which can be used by passing a `D

| Method | Parameter | Default | Description |
| ---------------------------- | --------- | --------- | -------------------------------------------------------------------------------------------------------------- |
| flushEventsIntervalMs | Int | 10000 | Controls the interval between flushing events to the DevCycle servers in milliseconds, defaults to 10 seconds. |
| eventFlushIntervalMS | Int | 10000 | Controls the interval between flushing events to the DevCycle servers in milliseconds, defaults to 10 seconds. |
| disableCustomEventLogging | Boolean | false | Disables logging of custom events generated by calling `.track()` method to DevCycle. |
| disableAutomaticEventLogging | Boolean | false | Disables logging of SDK generated events (e.g. variableEvaluated, variableDefaulted) to DevCycle. |
| logLevel | LogLevel | error | Set log level of the default logger. Defaults to `error` |
Expand Down
2 changes: 1 addition & 1 deletion docs/sdk/client-side-sdks/ios/ios-usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -245,7 +245,7 @@ if (err) {
### Manually Flush Events
The SDK will flush events every 10s or `flushEventsMS` specified in the options. To manually flush events, call:
The SDK will flush events every 10s or `eventFlushIntervalMS` specified in the options. To manually flush events, call:
**Swift**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,12 +33,12 @@ const devcycleClient = initializeDevCycle(

## Deferred Initialization

In many cases, user data is not available at the time of initialization. If the intialization call is made without a
In many cases, user data is not available at the time of initialization. If the initialization call is made without a
`user` object, then by default the SDK will be instantiated with an "anonymous" user and a configuration will be
downloaded from DevCycle. The SDK makes a call to get the configuration for anonymous user and initializes.

If you would like to defer initialization of the SDK until your user data is available, you can pass the
`deferInitialization` option to the `intializeDevCycle` method. This will cause the SDK to not fetch a configuration until the
`deferInitialization` option to the `initializeDevCycle` method. This will cause the SDK to not fetch a configuration until the
[`devcycleClient.identifyUser`](/sdk/client-side-sdks/javascript/javascript-usage#identifying-user) method is called with the user data.
Until that config is retrieved, all calls
to retrieve variable values will return their default values.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -113,10 +113,10 @@ const devcycleProvider = new DevCycleProvider('<DEVCYCLE_CLIENT_SDK_KEY>', optio
await OpenFeature.setProviderAndWait(devcycleProvider)
```

### Required TargetingKey
### TargetingKey or user_id

For DevCycle SDK to work we require either a `targetingKey` or `user_id` to be set on the OpenFeature context.
This is used to identify the user as the `user_id` for a `DevCycleUser` in DevCycle.
DevCycle recommends setting a `targetingKey` or `user_id` on the OpenFeature context to identify the user.
If neither is set, the provider initializes an anonymous user and evaluates flags for that anonymous user.

### Context properties to DevCycleUser

Expand Down
4 changes: 2 additions & 2 deletions docs/sdk/client-side-sdks/javascript/javascript-usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -159,7 +159,7 @@ See [getVariables](https://docs.devcycle.com/bucketing-api/#tag/Bucketing-API/op
This method is intended to be used for debugging and analytics purposes, _not_ as a method for retrieving the value of Variables to change code behaviour.
For that purpose, we strongly recommend using the individual variable access method described in [Using Variable Values](#using-variable-values)
Using this method instead will result in no evaluation events being tracked for individual variables, and will not allow the use
of other DevCycle features such as [Feature Reach](/platform/feature-flags/variables-and-variations/feature-flag-reach.md), [Metrics](docs/platform/experimentation/creating-and-managing-metrics.md), [Code Usage detection](/integrations/github/feature-usage-action), and [Stale Feature detection](/platform/feature-flags/stale-feature-notifications.md).
of other DevCycle features such as [Feature Reach](/platform/feature-flags/variables-and-variations/feature-flag-reach.md), [Metrics](/platform/experimentation/creating-and-managing-metrics.md), [Code Usage detection](/integrations/github/feature-usage-action), and [Stale Feature detection](/platform/feature-flags/stale-feature-notifications.md).

:::

Expand All @@ -180,7 +180,7 @@ const event = {
devcycleClient.track(event)
```

The SDK will flush events every 10s or `flushEventsMS` specified in the options. To manually flush events, call:
The SDK will flush events every 10s or `eventFlushIntervalMS` specified in the options. To manually flush events, call:

```javascript
await devcycleClient.flushEvents()
Expand Down
6 changes: 3 additions & 3 deletions docs/sdk/client-side-sdks/react-native/react-native-usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -150,7 +150,7 @@ Events can be tracked by calling the `track` method provided by the client objec
```js
const event = {
type: 'my_event_type', // this is required
date: Date().now(),
date: new Date(),
target: 'my_target',
value: 5,
metaData: {
Expand All @@ -160,7 +160,7 @@ const event = {
devcycleClient.track(event)
```

The SDK will flush events every 10s or `flushEventsMS` specified in the Provider options. To manually flush events, call:
The SDK will flush events every 10s or `eventFlushIntervalMS` specified in the Provider options. To manually flush events, call:

```js
await devcycleClient.flushEvents()
Expand All @@ -176,7 +176,7 @@ devcycleClient.flushEvents(() => {

EdgeDB allows you to save user data to our EdgeDB storage so that you don't have to pass in all the user data every time you identify a user.

To get started, contact us at support@devcycle.com to enable EdgeDB for your project.
To get started, enable EdgeDB on your project by following the guide [here](/platform/feature-flags/targeting/edgedb).

Once you have EdgeDB enabled in your project, pass in the `enableEdgeDB` option to turn on EdgeDB mode for the SDK:

Expand Down
6 changes: 3 additions & 3 deletions docs/sdk/client-side-sdks/react/react-openfeature.md
Original file line number Diff line number Diff line change
Expand Up @@ -122,10 +122,10 @@ const devcycleProvider = new DevCycleReactProvider(
await OpenFeature.setProviderAndWait(devcycleProvider)
```

### Required TargetingKey
### TargetingKey or user_id

For DevCycle SDK to work we require either a `targetingKey` or `user_id` to be set on the OpenFeature context.
This is used to identify the user as the `user_id` for a `DevCycleUser` in DevCycle.
DevCycle recommends setting a `targetingKey` or `user_id` on the OpenFeature context to identify the user.
If neither is set, the provider initializes an anonymous user and evaluates flags for that anonymous user.

### Context properties to DevCycleUser

Expand Down
2 changes: 1 addition & 1 deletion docs/sdk/client-side-sdks/react/react-usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -171,7 +171,7 @@ const event = {
devcycleClient.track(event)
```

The SDK will flush events every 10s or `flushEventsMS` specified in the Provider options. To manually flush events, call:
The SDK will flush events every 10s or `eventFlushIntervalMS` specified in the Provider options. To manually flush events, call:

```js
await devcycleClient.flushEvents()
Expand Down
2 changes: 1 addition & 1 deletion docs/sdk/client-side-sdks/roku/roku-install.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ import PromptContent from '!!raw-loader!@site/static/ai-prompts/roku.md'

This version of the DevCycle Client SDK supports the following platforms:

- **Roku OS 9.4+**
- **Roku OS 9.1+**

## Installation

Expand Down
6 changes: 3 additions & 3 deletions docs/sdk/client-side-sdks/roku/roku-usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -100,17 +100,17 @@ event = {
m.devcycleClient.track(event)
```

The SDK will flush events every 10s or `flushEventsMS` specified in the options. To manually flush events, call:
The SDK will flush events every 10s or `flushEventsIntervalMs` specified in the options. To manually flush events, call:

```javascript
m.devcycleClient.flushEvents()
```

## EdgeDB

EdgeDB allows you to save user data to our EdgeDB storage so that you don't have to pass in all the user data every time you identify a user. Read more about [EdgeDB](/platform/feature-flags/targeting/edgedb).
EdgeDB allows you to save user data to our EdgeDB storage so that you don't have to pass in all the user data every time you identify a user.

To get started, contact us at support@devcycle.com to enable EdgeDB for your project.
To get started, enable EdgeDB on your project by following the guide [here](/platform/feature-flags/targeting/edgedb).

Once you have EdgeDB enabled in your project, pass in the enableEdgeDB option to turn on EdgeDB mode for the SDK:

Expand Down
2 changes: 1 addition & 1 deletion docs/sdk/server-side-sdks/dotnet/dotnet-openfeature.md
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,7 @@ var variableResult = await oFeatureClient.GetStringDetails(readOnlyVariable.Key,

### Required TargetingKey

For DevCycle SDK to work we require either a `targetingKey` or `user_id` to be set on the OpenFeature context.
The DevCycle provider requires either a `targetingKey` or `user_id` to be set on the OpenFeature context.
This is used to identify the user as the `user_id` for a `DevCycleUser` in DevCycle.

### Context properties to DevCycleUser
Expand Down
2 changes: 1 addition & 1 deletion docs/sdk/server-side-sdks/go/go-openfeature.md
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ Use a Variable value by passing the Variable key, default value, and EvaluationC

### Required TargetingKey

For the DevCycle SDK to work we require either a `targetingKey` or `user_id` to be set on the OpenFeature context.
The DevCycle provider requires either a `targetingKey` or `user_id` to be set on the OpenFeature context.
This is used to identify the user as the `UserId` for a `devcycle.User` in DevCycle.

### Context properties to User
Expand Down
4 changes: 2 additions & 2 deletions docs/sdk/server-side-sdks/java/java-openfeature.md
Original file line number Diff line number Diff line change
Expand Up @@ -126,8 +126,8 @@ if (boolValue) {

### Required Targeting Key

For DevCycle SDK to work we require either a `targeting key` or `user_id` attribute to be set on the OpenFeature context.
This value is used to identify the user as the `user_id` property for a `DevCycleUser` in DevCycle.
The DevCycle provider requires either a `targetingKey` or `user_id` to be set on the OpenFeature context.
This is used to identify the user as the `user_id` for a `DevCycleUser` in DevCycle.

### Mapping Context Properties to DevCycleUser

Expand Down
2 changes: 1 addition & 1 deletion docs/sdk/server-side-sdks/nestjs/nestjs-gettingstarted.md
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@ DevCycleModule.forRoot({
| 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. |
| configPollingTimeoutMS | Number | Controls the request timeout to fetch new environment config changes, defaults to 5 seconds, must be less than the configPollingIntervalMS value, minimum value is 1 second. |
| eventFlushIntervalMS | Number | Controls the interval between flushing events to the DevCycle servers, defaults to 30 seconds. |
| eventFlushIntervalMS | Number | Controls the interval between flushing events to the DevCycle servers, defaults to 10 seconds. |
| disableAutomaticEventLogging | Boolean | Disables logging of sdk generated events (e.g. aggVariableEvaluated, aggVariableDefaulted) to DevCycle. |
| disableCustomEventLogging | Boolean | Disables logging of custom events, from `track()` method, and user data to DevCycle. |
| flushEventQueueSize | Number | Controls the maximum size the event queue can grow to until a flush is forced. Defaults to `1000`. |
Expand Down
2 changes: 1 addition & 1 deletion docs/sdk/server-side-sdks/nestjs/nestjs-openfeature.md
Original file line number Diff line number Diff line change
Expand Up @@ -150,7 +150,7 @@ const allFeatures = devcycleProvider.devcycleClient.allFeatures(dvcUser)

### Required TargetingKey

For DevCycle SDK to work we require either a `targetingKey` or `user_id` to be set on the OpenFeature context.
The DevCycle provider requires either a `targetingKey` or `user_id` to be set on the OpenFeature context.
This is used to identify the user as the `user_id` for a `DevCycleUser` in DevCycle.

### Context properties to DevCycleUser
Expand Down
2 changes: 1 addition & 1 deletion docs/sdk/server-side-sdks/node/node-gettingstarted.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ const devcycleClient = await DevCycle.initializeDevCycle(
| 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. |
| configPollingTimeoutMS | Number | Controls the request timeout to fetch new environment config changes, defaults to 5 seconds, must be less than the configPollingIntervalMS value, minimum value is 1 second. |
| eventFlushIntervalMS | Number | Controls the interval between flushing events to the DevCycle servers, defaults to 30 seconds. |
| eventFlushIntervalMS | Number | Controls the interval between flushing events to the DevCycle servers, defaults to 10 seconds. |
| disableAutomaticEventLogging | Boolean | Disables logging of sdk generated events (e.g. aggVariableEvaluated, aggVariableDefaulted) to DevCycle. |
| disableCustomEventLogging | Boolean | Disables logging of custom events, from `track()` method, and user data to DevCycle. |
| flushEventQueueSize | Number | Controls the maximum size the event queue can grow to until a flush is forced. Defaults to `1000`. |
Expand Down
2 changes: 1 addition & 1 deletion docs/sdk/server-side-sdks/node/node-openfeature.md
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,7 @@ const allFeatures = devcycleProvider.devcycleClient.allFeatures(dvcUser)

### Required TargetingKey

For DevCycle SDK to work we require either a `targetingKey` or `user_id` to be set on the OpenFeature context.
The DevCycle provider requires either a `targetingKey` or `user_id` to be set on the OpenFeature context.
This is used to identify the user as the `user_id` for a `DevCycleUser` in DevCycle.

### Context properties to DevCycleUser
Expand Down
2 changes: 1 addition & 1 deletion docs/sdk/server-side-sdks/php/php-openfeature.md
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ $flag_value = $openfeature_client->getStringValue("string-flag", "default", $ope

### Required TargetingKey

For DevCycle SDK to work we require either a `targetingKey` or `user_id` to be set on the OpenFeature context.
The DevCycle provider requires either a `targetingKey` or `user_id` to be set on the OpenFeature context.
This is used to identify the user as the `user_id` for a `DevCycleUser` in DevCycle. Setting the `user_id` property
will take priority over `targetingKey`.

Expand Down
2 changes: 1 addition & 1 deletion docs/sdk/server-side-sdks/python/python-openfeature.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ flag_value = client.get_boolean_value("boolean_flag", False)

### Required Targeting Key

For the DevCycle SDK to work we require either a `targeting_key` or `user_id` to be set on the OpenFeature context.
The DevCycle provider requires either a `targeting_key` or `user_id` to be set on the OpenFeature context.
This is used to identify the user as the `user_id` for a `DevCycleUser` in DevCycle.

### Context properties to DevCycleUser
Expand Down
Loading
Loading