Skip to content

Commit b3e4f69

Browse files
committed
documented locations modified when setting configuration
1 parent ed9af82 commit b3e4f69

1 file changed

Lines changed: 13 additions & 13 deletions

File tree

README.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -86,18 +86,18 @@ public class SetPlayerPrefs : MonoBehaviour
8686
```
8787
### Session Variable Documentation
8888

89-
|Variable Name | Description |
90-
| ----------- | ----------- |
91-
| LRSEnableUserLocation | This enables the external calls required to get user regional information packaged with the statement. This data is set in `$.context.extensions.http://ip-api.com/location` |
92-
|LRSEmail | User ID in the form of an email. Follows the [RFC 3987](https://datatracker.ietf.org/doc/html/rfc3987) specification.|
93-
|LRSAccountId | A User ID that's contained within a system. (Requires LRSHomepage to be set).|
94-
|LRSHomepage | A homepage for the LRSAccountId (Requires LRSAccountId to be set).|
95-
|LRSUsernameDisplay | A human readable username display.|
96-
|LRSGameId | A Game ID in the form of an IRI. Follows the [RFC 3987](https://datatracker.ietf.org/doc/html/rfc3987) specification.|
97-
|LRSGameDisplay| A human readable display of the game being played.|
98-
|LRSSessionIdentifier| A UUID that uniquely identifies the session being engaged with. This is something that would get set whenever the user initializes a new session.|
99-
|LRSActivityId| Optional ActivityID in the form of an IRI. Follows the [RFC 3987](https://datatracker.ietf.org/doc/html/rfc3987) specification.|
100-
|LRSActivityDefinition| human readable activity definition display. |
89+
|Variable Name | Description | Statement Fields Populated |
90+
| ----------- | ----------- | ----------- |
91+
|LRSEnableUserLocation | This enables the external calls required to get user regional information packaged with the statement. | `$.context.extensions.http://ip-api.com/location`|
92+
|LRSEmail | User ID in the form of an email. Follows the [RFC 3987](https://datatracker.ietf.org/doc/html/rfc3987) specification.| `$.actor.mbox`|
93+
|LRSAccountId | A User ID that's contained within a system. (Requires LRSHomepage to be set).| `$.actor.account.name`|
94+
|LRSHomepage | A homepage for the LRSAccountId (Requires LRSAccountId to be set).| `$.actor.account.homePage`|
95+
|LRSUsernameDisplay | A human readable username display.| `$.actor.name` |
96+
|LRSGameId | A Game ID in the form of an IRI. Follows the [RFC 3987](https://datatracker.ietf.org/doc/html/rfc3987) specification.| `$.object.id`, `$.context.platform`|
97+
|LRSGameDisplay| A human readable display of the game being played.| `$.object.definition.name.en-US`|
98+
|LRSSessionIdentifier| A UUID that uniquely identifies the session being engaged with. This is something that would get set whenever the user initializes a new session.| `$.context.registration`|
99+
|LRSActivityId| Optional ActivityID in the form of an IRI. Follows the [RFC 3987](https://datatracker.ietf.org/doc/html/rfc3987) specification.| `$.object.id`|
100+
|LRSActivityDefinition| human readable activity definition display. | `$.object.definition.name.en-US`|
101101

102102
### Setting up a Scene
103103

@@ -147,7 +147,7 @@ public class xApiIntegration : MonoBehaviour
147147
// Note that you can set LRSActivityId and LRSActivityDefinition to override the default activity (which is LRSGameId).
148148
publisher.SendStartedStatement();
149149

150-
// you can overload SendStartedStatement with a custom ActivityID if you wish to dynamically modify the activity like so:
150+
// you can overload SendStartedStatement with a custom ActivityID if you wish to dynamically modify the activity like so (overrides $.object.id and $.object.definition.name.en-US):
151151
publisher.SendStartedStatement("http://video.games/clicker/level/1", "Level 1 of clicking game");
152152
}
153153

0 commit comments

Comments
 (0)