From e43fc0d7dc9c70eedcdc16f491fca2ad695076b5 Mon Sep 17 00:00:00 2001 From: Vinyarion <38413862+VinyarionHyarmendacil@users.noreply.github.com> Date: Fri, 10 Mar 2023 15:14:16 -0600 Subject: [PATCH 1/2] Added NotificationV2 and Group Events NotificationV2 Events: notification-v2 notification-v2-update notification-v2-delete Group Events: group-joined group-left group-member-updated group-role-updated --- content/tutorials/websocket.markdown | 149 +++++++++++++++++++++++++++ 1 file changed, 149 insertions(+) diff --git a/content/tutorials/websocket.markdown b/content/tutorials/websocket.markdown index eb1ab7f..ca87a1f 100644 --- a/content/tutorials/websocket.markdown +++ b/content/tutorials/websocket.markdown @@ -90,6 +90,84 @@ A "`clear-notification`" event is sent when the client should clear **all** noti } ``` +### NotificationV2 Events + +The `content` object of these events all contain the property `"version": `, which appears to be a static indicator of + +#### notification-v2 +A "`notification-v2`" event carries a NotificationV2 object. + +```json +{ + "type": "notification-v2", + "content": { + "id": ":notificationId", + "version": 2, // Appears to be a static marker + "type": ":notificationV2TypeEnum", // One of: "group.announcement", ??? + "category": ":notificationV2CategoryEnum", // One of: "social.group", ??? + "isSystem": , + "ignoreDND": , + "senderUserId": ":userId", // NOTE: WILL BE NULL if the notification didn't originate from a user + "senderUsername": ":username", // NOTE: same as "senderUserId" + "receiverUserId": ":userId", + "relatedNotificationsId": ":?Id", + "title": ":string", + "message": ":string", + "imageUrl": ":assetUrl", + "link": ":notificationLinkUri", // The scheme is the type of the linked object, and the path is the id of that object, e.g.: "group:grp_00000000-0000-0000-0000-000000000000" + "linkText": ":string", + "responses": [ + { + "type": ":notificationV2ResponseTypeEnum", // One of: "delete", "unsubscribe", ??? + "data": ":string", // Auxiliary data + // If the type is "delete", then this will be empty + // If the type is "unsubscribe", then this will be + "icon": ":notificationV2ResponseIconEnum", // One of: "check", "bell-slash", ??? + "text": ":string" + } + ], + "expiresAt": "dateTimeString", // yyyy-mm-ddThh:mm:ss.sssZ + "expiryAfterSeen": , // Typically 900 + "requireSeen": , + "seen": , + "canDelete": , + "createdAt": ":dateTimeString", + "updatedAt": ":dateTimeString" + } +} +``` + +#### notification-v2-update +A "`notification-v2-update`" event is sent when the client should update a notification, overwriting at least one property. + +```json +{ + "type": "notification-v2-update", + "content": { + "id": ":notificationId", + "version": 2, + "updates": { + // These properties are to be overwrite the properties found in the content of a `notification-v2` event + } + } +} +``` + +#### notification-v2-delete +A "`notification-v2-delete`" event is sent when the client should delete one or more notifications. + +```json +{ + "type": "notification-v2-delete", + "content": { + "ids": [ + ":notificationId" + ], + "version": 2 + } +} +``` + --- ### Friend Events @@ -271,3 +349,74 @@ A "`user-location`" event is sent when the user has changed instances. } } ``` + +--- + +### Group Events + +#### group-joined +A "`group-joined`" event is sent when the user has either joined a group, or has had one of their group join requests accepted. + +```json +{ + "type": "group-joined", + "content": { + "groupId": ":groupId" // grp_00000000-0000-0000-000000000000 + } +} +``` + + +#### group-left +A "`group-left`" event is sent when the user has either left a group, or has been removed from a group. + +```json +{ + "type": "group-left", + "content": { + "groupId": ":groupId" + } +} +``` + + +#### group-member-updated +A "`group-member-updated`" event is sent when something regarding the user's group membership changes. Note that the `member` object is **not** a full GroupMember object, even though it has similarities. It's missing `user`, `createdAt`, `bannedAt`, and `managerNotes`. It also has the extra `lastPostReadAt` field. + +```json +{ + "type": "group-member-updated", + "content": { + "member": { + "id": ":groupMemberId", // gmem_00000000-0000-0000-000000000000 + "groupId": ":groupId", + "userId": ":userId", + "isRepresenting": , + "roleIds": [ + ":groupRoleId" // grol_00000000-0000-0000-000000000000 + ], + "joinedAt": ":dateTimeString", // yyyy-mm-ddThh:mm:ss.sssZ + "membershipStatus": ":groupMembershipEnum", // One of: "member", ??? + "visibility": ":groupVisibilityEnum", // One of: "visible", ??? + "isSubscribedToAnnouncements": , + "lastPostReadAt": ":dateTimeString" // NOTE: WILL BE NULL if the user hasn't read any group posts + } + } +} +``` + + +#### group-role-updated +A "`group-role-updated`" event is sent when something regarding one of the user's group's roles changes. + +```json +{ + "type": "group-role-updated", + "content": { + "role": { + // , See return data of Groups API: + // https://vrchatapi.github.io/docs/api/#get-/groups/-groupId-/roles + } + } +} +``` From 3fd140fe265d2b5538cc887353cebea53cb38751 Mon Sep 17 00:00:00 2001 From: Vinyarion <38413862+VinyarionHyarmendacil@users.noreply.github.com> Date: Fri, 10 Mar 2023 15:34:21 -0600 Subject: [PATCH 2/2] Fix some NotificationV2 things --- content/tutorials/websocket.markdown | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/content/tutorials/websocket.markdown b/content/tutorials/websocket.markdown index ca87a1f..55647d9 100644 --- a/content/tutorials/websocket.markdown +++ b/content/tutorials/websocket.markdown @@ -90,9 +90,9 @@ A "`clear-notification`" event is sent when the client should clear **all** noti } ``` -### NotificationV2 Events +#### About NotificationV2 Events -The `content` object of these events all contain the property `"version": `, which appears to be a static indicator of +The `version` property of the `content` of these events all currently have the value `2`. #### notification-v2 A "`notification-v2`" event carries a NotificationV2 object. @@ -110,7 +110,7 @@ A "`notification-v2`" event carries a NotificationV2 object. "senderUserId": ":userId", // NOTE: WILL BE NULL if the notification didn't originate from a user "senderUsername": ":username", // NOTE: same as "senderUserId" "receiverUserId": ":userId", - "relatedNotificationsId": ":?Id", + "relatedNotificationsId": ":?Id", // gpos_00000000-0000-0000-0000-000000000000 "title": ":string", "message": ":string", "imageUrl": ":assetUrl", @@ -121,7 +121,8 @@ A "`notification-v2`" event carries a NotificationV2 object. "type": ":notificationV2ResponseTypeEnum", // One of: "delete", "unsubscribe", ??? "data": ":string", // Auxiliary data // If the type is "delete", then this will be empty - // If the type is "unsubscribe", then this will be + // If the type is "unsubscribe", then this will be the id of the sending object, a comma, and the id of the (recieving) user + // e.g.: grp_00000000-0000-0000-000000000000,usr_00000000-0000-0000-000000000000 "icon": ":notificationV2ResponseIconEnum", // One of: "check", "bell-slash", ??? "text": ":string" }