hytopia 0.10.34 → 0.10.35-notifications-prerelease-2

package/docs/server.player.md

@@ -291,6 +291,20 @@ Joins a player to a world.
 Resets all inputs keys
 
 
+</td></tr>
+<tr><td>
+
+[scheduleNotification(type, scheduledFor)](./server.player.schedulenotification.md)
+
+
+</td><td>
+
+
+</td><td>
+
+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.
+
+
 </td></tr>
 <tr><td>
 
@@ -305,6 +319,20 @@ Resets all inputs keys
 Set the persisted data for the player. This data can later be retrieved using [Player.getPersistedData()](./server.player.getpersisteddata.md)<!-- -->, even if a player disconnects and rejoin a game in the future, or joins a different HYTOPIA managed lobby of your game.
 
 
+</td></tr>
+<tr><td>
+
+[unscheduleNotification(notificationId)](./server.player.unschedulenotification.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Unschedules a scheduled notification for the player.
+
+
 </td></tr>
 </tbody></table>
 

package/docs/server.player.schedulenotification.md

@@ -0,0 +1,72 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [Player](./server.player.md) &gt; [scheduleNotification](./server.player.schedulenotification.md)
+
+## Player.scheduleNotification() method
+
+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.
+
+**Signature:**
+
+```typescript
+scheduleNotification(type: string, scheduledFor: number): Promise<string | void>;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+type
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+The type of notification to schedule.
+
+
+</td></tr>
+<tr><td>
+
+scheduledFor
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+A future timestamp in milliseconds to schedule the notification for.
+
+
+</td></tr>
+</tbody></table>
+
+**Returns:**
+
+Promise&lt;string \| void&gt;
+
+The id of the notification if it was scheduled successfully, undefined otherwise.
+

package/docs/server.player.unschedulenotification.md

@@ -0,0 +1,56 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [Player](./server.player.md) &gt; [unscheduleNotification](./server.player.unschedulenotification.md)
+
+## Player.unscheduleNotification() method
+
+Unschedules a scheduled notification for the player.
+
+**Signature:**
+
+```typescript
+unscheduleNotification(notificationId: string): Promise<boolean>;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+notificationId
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+The id of the notification returned from [Player.scheduleNotification()](./server.player.schedulenotification.md)<!-- -->.
+
+
+</td></tr>
+</tbody></table>
+
+**Returns:**
+
+Promise&lt;boolean&gt;
+
+boolean - True if the notification was unscheduled, false otherwise.
+

package/docs/server.playerevent.md

@@ -85,6 +85,20 @@ RECONNECTED\_WORLD
 </td><td>
 
 
+</td></tr>
+<tr><td>
+
+REQUEST\_NOTIFICATION\_PERMISSION
+
+
+</td><td>
+
+`"PLAYER.REQUEST_NOTIFICATION_PERMISSION"`
+
+
+</td><td>
+
+
 </td></tr>
 <tr><td>
 

package/docs/server.playereventpayloads._player.request_notification_permission_.md

@@ -0,0 +1,15 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [PlayerEventPayloads](./server.playereventpayloads.md) &gt; ["PLAYER.REQUEST\_NOTIFICATION\_PERMISSION"](./server.playereventpayloads._player.request_notification_permission_.md)
+
+## PlayerEventPayloads."PLAYER.REQUEST\_NOTIFICATION\_PERMISSION" property
+
+Emitted when notification permission is requested by a game.
+
+**Signature:**
+
+```typescript
+[PlayerEvent.REQUEST_NOTIFICATION_PERMISSION]: {
+        player: Player;
+    };
+```

package/docs/server.playereventpayloads.md

@@ -110,6 +110,25 @@ Emitted when a player leaves a world.
 Emitted when a player reconnects to a world after a unintentional disconnect.
 
 
+</td></tr>
+<tr><td>
+
+["PLAYER.REQUEST\_NOTIFICATION\_PERMISSION"](./server.playereventpayloads._player.request_notification_permission_.md)
+
+
+</td><td>
+
+
+</td><td>
+
+{ player: [Player](./server.player.md)<!-- -->; }
+
+
+</td><td>
+
+Emitted when notification permission is requested by a game.
+
+
 </td></tr>
 <tr><td>
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "hytopia",
-  "version": "0.10.34",
+  "version": "0.10.35-notifications-prerelease-2",
   "description": "The HYTOPIA SDK makes it easy for developers to create massively multiplayer games using JavaScript or TypeScript.",
   "type": "module",
   "main": "./server.mjs",

package/server.api.json

@@ -35830,6 +35830,75 @@
               "isAbstract": false,
               "name": "resetInputs"
             },
+            {
+              "kind": "Method",
+              "canonicalReference": "server!Player#scheduleNotification:member(1)",
+              "docComment": "/**\n * 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.\n *\n * @param type - The type of notification to schedule.\n *\n * @param scheduledFor - A future timestamp in milliseconds to schedule the notification for.\n *\n * @returns The id of the notification if it was scheduled successfully, undefined otherwise.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "scheduleNotification(type: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string"
+                },
+                {
+                  "kind": "Content",
+                  "text": ", scheduledFor: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "number"
+                },
+                {
+                  "kind": "Content",
+                  "text": "): "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "Promise",
+                  "canonicalReference": "!Promise:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": "<string | void>"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isStatic": false,
+              "returnTypeTokenRange": {
+                "startIndex": 5,
+                "endIndex": 7
+              },
+              "releaseTag": "Public",
+              "isProtected": false,
+              "overloadIndex": 1,
+              "parameters": [
+                {
+                  "parameterName": "type",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 1,
+                    "endIndex": 2
+                  },
+                  "isOptional": false
+                },
+                {
+                  "parameterName": "scheduledFor",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 3,
+                    "endIndex": 4
+                  },
+                  "isOptional": false
+                }
+              ],
+              "isOptional": false,
+              "isAbstract": false,
+              "name": "scheduleNotification"
+            },
             {
               "kind": "Method",
               "canonicalReference": "server!Player#setPersistedData:member(1)",
@@ -35914,6 +35983,59 @@
               "isProtected": false,
               "isAbstract": false
             },
+            {
+              "kind": "Method",
+              "canonicalReference": "server!Player#unscheduleNotification:member(1)",
+              "docComment": "/**\n * Unschedules a scheduled notification for the player.\n *\n * @param notificationId - The id of the notification returned from {@link Player.scheduleNotification}.\n *\n * @returns boolean - True if the notification was unscheduled, false otherwise.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "unscheduleNotification(notificationId: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string"
+                },
+                {
+                  "kind": "Content",
+                  "text": "): "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "Promise",
+                  "canonicalReference": "!Promise:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": "<boolean>"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isStatic": false,
+              "returnTypeTokenRange": {
+                "startIndex": 3,
+                "endIndex": 5
+              },
+              "releaseTag": "Public",
+              "isProtected": false,
+              "overloadIndex": 1,
+              "parameters": [
+                {
+                  "parameterName": "notificationId",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 1,
+                    "endIndex": 2
+                  },
+                  "isOptional": false
+                }
+              ],
+              "isOptional": false,
+              "isAbstract": false,
+              "name": "unscheduleNotification"
+            },
             {
               "kind": "Property",
               "canonicalReference": "server!Player#username:member",
@@ -38898,6 +39020,27 @@
               "releaseTag": "Public",
               "name": "RECONNECTED_WORLD"
             },
+            {
+              "kind": "EnumMember",
+              "canonicalReference": "server!PlayerEvent.REQUEST_NOTIFICATION_PERMISSION:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "REQUEST_NOTIFICATION_PERMISSION = "
+                },
+                {
+                  "kind": "Content",
+                  "text": "\"PLAYER.REQUEST_NOTIFICATION_PERMISSION\""
+                }
+              ],
+              "initializerTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "releaseTag": "Public",
+              "name": "REQUEST_NOTIFICATION_PERMISSION"
+            },
             {
               "kind": "EnumMember",
               "canonicalReference": "server!PlayerEvent.REQUEST_SYNC:member",
@@ -39143,6 +39286,51 @@
                 "endIndex": 8
               }
             },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "server!PlayerEventPayloads#\"PLAYER.REQUEST_NOTIFICATION_PERMISSION\":member",
+              "docComment": "/**\n * Emitted when notification permission is requested by a game.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "["
+                },
+                {
+                  "kind": "Reference",
+                  "text": "PlayerEvent.REQUEST_NOTIFICATION_PERMISSION",
+                  "canonicalReference": "server!PlayerEvent.REQUEST_NOTIFICATION_PERMISSION:member"
+                },
+                {
+                  "kind": "Content",
+                  "text": "]: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "{\n        player: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "Player",
+                  "canonicalReference": "server!Player:class"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";\n    }"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "\"PLAYER.REQUEST_NOTIFICATION_PERMISSION\"",
+              "propertyTypeTokenRange": {
+                "startIndex": 3,
+                "endIndex": 6
+              }
+            },
             {
               "kind": "PropertySignature",
               "canonicalReference": "server!PlayerEventPayloads#\"PLAYER.REQUEST_SYNC\":member",

package/server.d.ts

@@ -4435,6 +4435,23 @@ export declare class Player extends EventRouter implements protocol.Serializable
      * @param world - The world to join the player to.
      */
     joinWorld(world: World): void;
+    /**
+     * 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.
+     *
+     * @param type - The type of notification to schedule.
+     * @param scheduledFor - A future timestamp in milliseconds to schedule the notification for.
+     * @returns The id of the notification if it was scheduled successfully, undefined otherwise.
+     */
+    scheduleNotification(type: string, scheduledFor: number): Promise<string | void>;
+    /**
+     * Unschedules a scheduled notification for the player.
+     *
+     * @param notificationId - The id of the notification returned from {@link Player.scheduleNotification}.
+     * @returns boolean - True if the notification was unscheduled, false otherwise.
+     */
+    unscheduleNotification(notificationId: string): Promise<boolean>;
 
 
     /**
@@ -4829,6 +4846,7 @@ export declare enum PlayerEvent {
     JOINED_WORLD = "PLAYER.JOINED_WORLD",
     LEFT_WORLD = "PLAYER.LEFT_WORLD",
     RECONNECTED_WORLD = "PLAYER.RECONNECTED_WORLD",
+    REQUEST_NOTIFICATION_PERMISSION = "PLAYER.REQUEST_NOTIFICATION_PERMISSION",
     REQUEST_SYNC = "PLAYER.REQUEST_SYNC"
 }
 
@@ -4854,6 +4872,10 @@ export declare interface PlayerEventPayloads {
         player: Player;
         world: World;
     };
+    /** Emitted when notification permission is requested by a game. */
+    [PlayerEvent.REQUEST_NOTIFICATION_PERMISSION]: {
+        player: Player;
+    };
     /** Emitted when a player's client requests a round trip time synchronization. */
     [PlayerEvent.REQUEST_SYNC]: {
         player: Player;