Riferimento API

Appunti

Verificare app.capabilities per il supporto delle funzionalità e app.access insieme alle autorizzazioni host per l’autorizzazione. Gli esempi usano valori sintetici; sostituire percorsi, ID, input e filtri prima della chiamata.

Definizioni di tipo

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

Operazioni

mutation

deleteClipboardItems

Eliminare i record corrispondenti della cronologia degli appunti; usare una query esplicita all:true per eliminare tutti i record.

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

Scrivere testo negli appunti del dispositivo e registrare la scrittura nella cronologia degli appunti.

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

Contare le voci della cronologia degli appunti corrispondenti alla query.

graphql
query clipboardItemCount($query: String!) {
  clipboardItemCount(query: $query)
}
query

clipboardItems

Leggere le voci corrispondenti della cronologia degli appunti con paginazione, dalle più recenti.

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

Ricevere informazioni sulle modifiche agli appunti.

graphql
subscription clipboardChanged {
  clipboardChanged { text sensitive time }
}