Skip to content

Commit 7c02a3b

Browse files
committed
feat: document the didReceiveDeepLink clientbound event
1 parent 85c17b8 commit 7c02a3b

File tree

2 files changed

+23
-0
lines changed

2 files changed

+23
-0
lines changed

src/4_clientbound/deep_link.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# Deep link
2+
3+
### didReceiveDeepLink
4+
5+
Fired when a deep link URL matching a format for sending messages to the plugin is opened.
6+
7+
The URL formats that can trigger this event are
8+
- `openaction://plugins/message/<PLUGIN_DIRECTORY_NAME>/<MESSAGE_CONTENT>[?openaction=hidden]` and
9+
- `streamdeck://plugins/message/<PLUGIN_UUID>/<MESSAGE_CONTENT>[?streamdeck=hidden]`,
10+
11+
where the optional query parameter specifies that the OpenAction server's window should not be brought to the foreground when the deep link is opened.
12+
13+
**Received by:** Plugin
14+
15+
```ts
16+
{
17+
event: string = "didReceiveDeepLink",
18+
payload: {
19+
url: string
20+
}
21+
}
22+
```

src/SUMMARY.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@
77
- [Registration](3_registration.md)
88
- [Clientbound events](4_clientbound/0_index.md)
99
- [Applications](4_clientbound/applications.md)
10+
- [Deep link](4_clientbound/deep_link.md)
1011
- [Devices](4_clientbound/devices.md)
1112
- [Encoder](4_clientbound/encoder.md)
1213
- [Keypad](4_clientbound/keypad.md)

0 commit comments

Comments
 (0)