API リファレンス
クリップボード
機能の対応状況は app.capabilities、認可は app.access とホストの権限で確認してください。例は合成値を使用しています。呼び出す前にパス、ID、入力、フィルターを置き換えてください。
型定義
graphql
type Mutation {
deleteClipboardItems(query: String!): ActionResult!
setClipboard(text: String!, label: String! = "", sensitive: Boolean! = false): Boolean!
}
type Query {
clipboardItemCount(query: String!): Int!
clipboardItems(query: String!, offset: Int!, limit: Int!): [ClipboardItem!]!
}
type Subscription {
clipboardChanged: ClipboardChange!
}
type ActionResult {
affectedCount: Int!
}
type ClipboardChange {
text: String!
sensitive: Boolean!
time: Instant!
}
type ClipboardItem {
id: ID!
text: String!
source: String!
label: String!
sensitive: Boolean!
createdAt: Instant!
}
scalar Instant操作
mutation
deleteClipboardItems
一致するクリップボード履歴レコードを削除します。全レコードを削除するには all:true クエリを明示的に使用します。
graphql
# Delete clipboard history entries matching the query DSL (`ids:` /
# `text:`; a bare word is a text LIKE). A blank query is rejected —
# send `all:true` to target everything.
mutation deleteClipboardItems($query: String!) {
deleteClipboardItems(query: $query) { affectedCount }
}mutation
setClipboard
デバイスのクリップボードにテキストを書き込み、クリップボード履歴にも記録します。
graphql
# Record caller-attributed history only after a successful system write; suppress watcher echoes.
mutation setClipboard($text: String!, $label: String!, $sensitive: Boolean!) {
setClipboard(text: $text, label: $label, sensitive: $sensitive)
}query
clipboardItemCount
クエリに一致するクリップボード履歴の件数を数えます。
graphql
query clipboardItemCount($query: String!) {
clipboardItemCount(query: $query)
}query
clipboardItems
一致するクリップボード履歴を、新しい順にページ単位で読み取ります。
graphql
# Paged clipboard history, newest first.
query clipboardItems($query: String!, $offset: Int!, $limit: Int!) {
clipboardItems(query: $query, offset: $offset, limit: $limit) { id text source label sensitive createdAt }
}subscription
clipboardChanged
クリップボードの変更情報を受信します。
graphql
subscription clipboardChanged {
clipboardChanged { text sensitive time }
}