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 }
}