hytopia 0.10.20 → 0.10.21

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,72 +0,0 @@
1
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
-
3
- [Home](./index.md) &gt; [server](./server.md) &gt; [Player](./server.player.md) &gt; [scheduleNotification](./server.player.schedulenotification.md)
4
-
5
- ## Player.scheduleNotification() method
6
-
7
- Schedule a notification the player at a point in time in the future. This will automatically handle prompting a player (if necessary) for notification permissions in-game.
8
-
9
- **Signature:**
10
-
11
- ```typescript
12
- scheduleNotification(type: string, scheduledFor: number): Promise<string | void>;
13
- ```
14
-
15
- ## Parameters
16
-
17
- <table><thead><tr><th>
18
-
19
- Parameter
20
-
21
-
22
- </th><th>
23
-
24
- Type
25
-
26
-
27
- </th><th>
28
-
29
- Description
30
-
31
-
32
- </th></tr></thead>
33
- <tbody><tr><td>
34
-
35
- type
36
-
37
-
38
- </td><td>
39
-
40
- string
41
-
42
-
43
- </td><td>
44
-
45
- The type of notification to schedule.
46
-
47
-
48
- </td></tr>
49
- <tr><td>
50
-
51
- scheduledFor
52
-
53
-
54
- </td><td>
55
-
56
- number
57
-
58
-
59
- </td><td>
60
-
61
- The point in time in the future to schedule the notification for.
62
-
63
-
64
- </td></tr>
65
- </tbody></table>
66
-
67
- **Returns:**
68
-
69
- Promise&lt;string \| void&gt;
70
-
71
- The id of the notification if it was scheduled successfully, undefined otherwise.
72
-
@@ -1,56 +0,0 @@
1
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
-
3
- [Home](./index.md) &gt; [server](./server.md) &gt; [Player](./server.player.md) &gt; [unscheduleNotification](./server.player.unschedulenotification.md)
4
-
5
- ## Player.unscheduleNotification() method
6
-
7
- Unschedules a scheduled notification for the player.
8
-
9
- **Signature:**
10
-
11
- ```typescript
12
- unscheduleNotification(notificationId: string): Promise<boolean>;
13
- ```
14
-
15
- ## Parameters
16
-
17
- <table><thead><tr><th>
18
-
19
- Parameter
20
-
21
-
22
- </th><th>
23
-
24
- Type
25
-
26
-
27
- </th><th>
28
-
29
- Description
30
-
31
-
32
- </th></tr></thead>
33
- <tbody><tr><td>
34
-
35
- notificationId
36
-
37
-
38
- </td><td>
39
-
40
- string
41
-
42
-
43
- </td><td>
44
-
45
- The id of the notification returned from [Player.scheduleNotification()](./server.player.schedulenotification.md)<!-- -->.
46
-
47
-
48
- </td></tr>
49
- </tbody></table>
50
-
51
- **Returns:**
52
-
53
- Promise&lt;boolean&gt;
54
-
55
- boolean - True if the notification was unscheduled, false otherwise.
56
-
@@ -1,15 +0,0 @@
1
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
-
3
- [Home](./index.md) &gt; [server](./server.md) &gt; [PlayerEventPayloads](./server.playereventpayloads.md) &gt; ["PLAYER.REQUEST\_NOTIFICATION\_PERMISSION"](./server.playereventpayloads._player.request_notification_permission_.md)
4
-
5
- ## PlayerEventPayloads."PLAYER.REQUEST\_NOTIFICATION\_PERMISSION" property
6
-
7
- Emitted when notification permission is requested by a game.
8
-
9
- **Signature:**
10
-
11
- ```typescript
12
- [PlayerEvent.REQUEST_NOTIFICATION_PERMISSION]: {
13
- player: Player;
14
- };
15
- ```