Skip to content

Commit f6fb4fd

Browse files
committed
Update README.md
Updates properties and links to the generated doc for appEvent properties.
1 parent be438b6 commit f6fb4fd

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

README.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -171,6 +171,8 @@ var exports = function TrakerrClient(apiKey,
171171

172172
The TrakerrClient module has a lot of exposed properties. The benefit to setting these immediately after after you create the TrakerrClient is that AppEvent will default it's values against the TrakerClient that created it. This way if there is a value that all your AppEvents uses, and the constructor default value currently doesn't suit you; it may be easier to change it in TrakerrClient as it will become the default value for all AppEvents created after. A lot of these are populated by default value by the constructor, but you can populate them with whatever string data you want. The following table provides an in depth look at each of those.
173173

174+
If you're populating an app event directly, you'll want to take a look at the [AppEvent properties](generated/docs/AppEvent.md) as they contain properties unique to each AppEvent which do not have defaults you may set in the client.
175+
174176
Name | Type | Description | Notes
175177
------------ | ------------- | ------------- | -------------
176178
**apiKey** | **string** | API key generated for the application |
@@ -184,8 +186,10 @@ Name | Type | Description | Notes
184186
**contextAppOSVersion** | **string** | OS Version the application is running on. | Default value: OS Version.
185187
**contextAppOSBrowser** | **string** | An optional string browser name the application is running on. | Defaults to the browser name if the app is running from a browser.
186188
**contextAppOSBrowserVersion** | **string** | An optional string browser version the application is running on. | Defaults to the browser version if the app is running from a browser.
187-
**contextDataCenter** | **string** | Data center the application is running on or connected to. | Defaults to `nil`
188-
**contextDataCenterRegion** | **string** | Data center region. | Defaults to `nil`
189+
**contextDataCenter** | **string** | Data center the application is running on or connected to. | Defaults to `'undefined'`
190+
**contextDataCenterRegion** | **string** | Data center region. | Defaults to `'undefined'`
191+
**contextTags** | **Array.<String>** | Array of string tags you can use to tag your components for searching., | Defaults to `'undefined'`
192+
**contextAppSKU** | **string** | Application SKU. | Defaults to `'undefined'`
189193

190194

191195
## Documentation for AppEvent

0 commit comments

Comments
 (0)