Skip to content

Commit

Permalink
docs: Update description of currentTime in the Unleash context.
Browse files Browse the repository at this point in the history
  • Loading branch information
@thomasheartman
thomasheartman committed Mar 8, 2022
1 parent 2f6b067 commit 419dda0
Showing 1 changed file with 10 additions and 9 deletions.
19 changes: 10 additions & 9 deletions website/docs/user_guide/unleash-context.md
View file
Expand Up @@ -17,15 +17,16 @@ _All fields are optional_, but some strategies depend on certain fields being pr

The below table gives a brief overview over what the fields' intended usage is, their lifetime, and their type. Note that the exact type can vary between programming languages and implementations. Be sure to consult your specific client SDK for more information on its implementation of the Unleash Context.

| field name | type | lifetime | description |
|-------------------|-----------------------|---------------------|--------------------------------------------------------------------------------------------|
| `appName` | `string` | static | the name of the application |
| `environment`[^1] | `string` | static | the environment the app is running in |
| `userId` | `string` | dynamic | an identifier for the current user |
| `sessionId` | `string` | dynamic | an identifier for the current session |
| `remoteAddress` | `string` | dynamic | an identifier for the current session |
| `properties` | `Map<string, string>` | dynamic | a key-value store of any data you want |
| `currentTime`[^2] | `DateTime`/`string` | special / read-only | A `DateTime` (or similar) data class instance or a string in an RFC3339-compatible format. |
| field name | type | lifetime | description |
|-------------------|-----------------------|----------|-----------------------------------------------------------------------------------------------------------------------------------------------------|
| `appName` | `string` | static | the name of the application |
| `environment`[^1] | `string` | static | the environment the app is running in |
| `userId` | `string` | dynamic | an identifier for the current user |
| `sessionId` | `string` | dynamic | an identifier for the current session |
| `remoteAddress` | `string` | dynamic | an identifier for the current session |
| `properties` | `Map<string, string>` | dynamic | a key-value store of any data you want |
| `currentTime`[^2] | `DateTime`/`string` | dynamic | A `DateTime` (or similar) data class instance or a string in an RFC3339-compatible format. **Defaults to the current time** if not set by the user. |
| | | | |


### The `properties` field
Expand Down

0 comments on commit 419dda0

Please sign in to comment.