Skip to content

Commit 13cd5f1

Browse files
committed
fix: include context property in the setGlobalSettings and getGlobalSettings serverbound events
1 parent 11559d7 commit 13cd5f1

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

src/5_serverbound/settings.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -30,25 +30,27 @@ Used to get the settings value of an instance. When used, the OpenAction server
3030

3131
### setGlobalSettings
3232

33-
Used to set the plugin-wide global settings value. When used by the plugin, all property inspectors will receive a `didReceiveGlobalSettings` event, and vice versa.
33+
Used to set the plugin-wide global settings value. When used by the plugin, all property inspectors will receive a `didReceiveGlobalSettings` event, and vice versa. The `context` property should be set to the UUID value received during [registration](../3_registration.md).
3434

3535
**Sent by:** Plugin, Property inspector
3636

3737
```ts
3838
{
3939
event: string = "setGlobalSettings",
40+
context: string,
4041
payload: any
4142
}
4243
```
4344

4445
### getGlobalSettings
4546

46-
Used to get the plugin-wide global settings value. When used, the OpenAction server will respond with a `didReceiveGlobalSettings` event.
47+
Used to get the plugin-wide global settings value. When used, the OpenAction server will respond with a `didReceiveGlobalSettings` event. The `context` property should be set to the UUID value received during [registration](../3_registration.md).
4748

4849
**Sent by:** Plugin, Property inspector
4950

5051
```ts
5152
{
52-
event: string = "getGlobalSettings"
53+
event: string = "getGlobalSettings",
54+
context: string
5355
}
5456
```

0 commit comments

Comments
 (0)