API 參考
通知
透過 app.capabilities 判斷功能支援,透過 app.access 和主機權限判斷存取授權。範例使用合成值;呼叫前請替換路徑、ID、輸入和篩選條件。
型別定義
graphql
type Subscription {
notificationCreated: Notification!
notificationUpdated: Notification!
notificationDeleted: Notification!
notificationRefreshed: Boolean!
}
type Mutation {
deleteNotifications(ids: [ID!]!): ActionResult!
replyNotification(id: ID!, actionIndex: Int!, text: String!): Boolean!
}
type Query {
notificationCount(query: String!): Int!
notifications(query: String!, offset: Int!, limit: Int!): [Notification!]!
}
type ActionResult {
affectedCount: Int!
}
scalar Instant
type Notification {
id: ID!
onlyOnce: Boolean!
isClearable: Boolean!
appId: ID!
appName: String!
postedAt: Instant!
silent: Boolean!
title: String!
body: String!
actions: [String!]!
replyActions: [String!]!
}操作
subscription
notificationCreated
接收新觀察到的裝置通知。
graphql
subscription notificationCreated {
notificationCreated { id onlyOnce isClearable appId appName postedAt silent title }
}subscription
notificationUpdated
接收已更新的裝置通知。
graphql
subscription notificationUpdated {
notificationUpdated { id onlyOnce isClearable appId appName postedAt silent title }
}subscription
notificationDeleted
接收已移除的裝置通知。
graphql
subscription notificationDeleted {
notificationDeleted { id onlyOnce isClearable appId appName postedAt silent title }
}subscription
notificationRefreshed
接收刷新目前裝置通知清單的訊號。
graphql
subscription notificationRefreshed {
notificationRefreshed
}mutation
deleteNotifications
刪除指定通知記錄,並回傳受影響數量。
graphql
mutation deleteNotifications($ids: [ID!]!) {
deleteNotifications(ids: $ids) { affectedCount }
}mutation
replyNotification
透過內嵌回覆動作回覆通知;actionIndex 是可回覆動作中從 0 開始的索引。
graphql
# `actionIndex` indexes [`Notification::reply_actions`], the
# reply-capable subset — not the plain action list.
mutation replyNotification($id: ID!, $actionIndex: Int!, $text: String!) {
replyNotification(id: $id, actionIndex: $actionIndex, text: $text)
}query
notificationCount
統計符合查詢條件的已儲存通知數。
graphql
query notificationCount($query: String!) {
notificationCount(query: $query)
}query
notifications
分頁讀取符合查詢條件的已儲存裝置通知。
graphql
query notifications($query: String!, $offset: Int!, $limit: Int!) {
notifications(query: $query, offset: $offset, limit: $limit) { id onlyOnce isClearable appId appName postedAt silent title }
}