文档API 参考

Rust · 0.1.0

UserNotification

应用协议结构。字段名称及继承的描述保留原始语言。

此结构在哪里使用

以下链接根据协议快照中的直接引用生成。认证、可写字段和运行行为应以调用操作为准;可复用资源结构本身并不是完整的写入请求。

被以下组件结构引用:

结构与字段

object

字段类型 / 是否必需描述
namestringThe resource name of the notification. Format: users/{user}/notifications/{notification}
senderstringThe sender of the notification. Format: users/{user}
senderUserallOf
User
The sender user details.
statusstring (enum)
STATUS_UNSPECIFIED · UNREAD · ARCHIVED
The status of the notification.
createTimestring (date-time)The creation timestamp.
typestring (enum)
TYPE_UNSPECIFIED · MEMO_COMMENT · MEMO_MENTION · SPACE_INVITATION
The type of the notification.
memoCommentallOf
UserNotification_MemoCommentPayload
memoMentionallOf
UserNotification_MemoMentionPayload
spaceInvitationallOf
UserNotification_SpaceInvitationPayload

完整结构

约束与嵌套结构请以这份完整 JSON 定义为准。字段出现在这里,并不意味着每位调用者都能修改它。

{
  "type": "object",
  "properties": {
    "name": {
      "readOnly": true,
      "type": "string",
      "description": "The resource name of the notification.\n Format: users/{user}/notifications/{notification}"
    },
    "sender": {
      "readOnly": true,
      "type": "string",
      "description": "The sender of the notification.\n Format: users/{user}"
    },
    "senderUser": {
      "readOnly": true,
      "allOf": [
        {
          "$ref": "#/components/schemas/User"
        }
      ],
      "description": "The sender user details."
    },
    "status": {
      "enum": [
        "STATUS_UNSPECIFIED",
        "UNREAD",
        "ARCHIVED"
      ],
      "type": "string",
      "description": "The status of the notification.",
      "format": "enum"
    },
    "createTime": {
      "readOnly": true,
      "type": "string",
      "description": "The creation timestamp.",
      "format": "date-time"
    },
    "type": {
      "readOnly": true,
      "enum": [
        "TYPE_UNSPECIFIED",
        "MEMO_COMMENT",
        "MEMO_MENTION",
        "SPACE_INVITATION"
      ],
      "type": "string",
      "description": "The type of the notification.",
      "format": "enum"
    },
    "memoComment": {
      "readOnly": true,
      "allOf": [
        {
          "$ref": "#/components/schemas/UserNotification_MemoCommentPayload"
        }
      ]
    },
    "memoMention": {
      "readOnly": true,
      "allOf": [
        {
          "$ref": "#/components/schemas/UserNotification_MemoMentionPayload"
        }
      ]
    },
    "spaceInvitation": {
      "readOnly": true,
      "allOf": [
        {
          "$ref": "#/components/schemas/UserNotification_SpaceInvitationPayload"
        }
      ]
    }
  }
}