Riferimento API

Associazione

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.

Device A
plainapp://pair?request=<URL-encoded JSON>
Device B

QR

QR payload

QR: A mostra, B scansiona. In LAN c-id identifica il mittente; BLE usa il proprio trasporto. PAIR_CANCEL è facoltativo.

Passare il puntatore o toccare un campo
1 / 2

Istantanea sintetica a un istante fisso; firme e requestIds corrispondono. 192.0.2.0/24 è riservato alla documentazione. 8443 è la porta HTTPS predefinita; usare la porta rilevata nelle richieste reali. Queste richieste a validità limitata non possono essere riprodotte così come sono.

In PlainApp Desktop, per gestire un nuovo dispositivo o un dispositivo la cui chiave pubblica è cambiata, conferma prima di ritenerlo attendibile. In questo passaggio non compare alcun codice di confronto; se la chiave è cambiata, viene mostrato un avviso. Se non hai usato una password, confronta il codice mostrato su entrambi i dispositivi prima di approvare la richiesta sull’altro dispositivo. Con la password, l’altro dispositivo può chiedere l’approvazione senza mostrare un codice.

Definizioni di tipo

graphql
type Subscription {
  peersChanged: Boolean!
  pairingRequested: PairingRequestNotice!
  pairingCompleted: PairingCompletedNotice!
  pairingStarted: PairingProgressNotice!
  pairingFailed: PairingProgressNotice!
  pairingCanceled: PairingProgressNotice!
}

type Mutation {
  cancelPairing(peerId: ID!): Boolean!
  deletePeer(peerId: ID!): Boolean!
  pairPeer(peerId: ID!, input: PairPeerInput!): Boolean!
  respondToPairing(peerId: ID!, accepted: Boolean!): Boolean!
  unpairPeer(peerId: ID!): Boolean!
}

type Query {
  peerFileUrl(peerId: ID!, fileId: String!): String!
  peers: [Peer!]!
}

enum DeviceType {
	COMPUTER
	PHONE
	TABLET
	TV
	NAS
	OTHER
}

scalar Instant

input PairPeerInput {
	mode: PairingMode!
	password: String
}

type PairingCompletedNotice {
	deviceId: ID!
	deviceName: String!
	ip: String!
	port: Int
	deviceType: DeviceType
	requestId: String
}

enum PairingErrorCode {
	TIMEOUT
	REJECTED
	PASSWORD_REQUIRED
	INVALID_PASSWORD
	PEER_IDENTITY_CHANGED
	TOO_MANY_LOGIN_ATTEMPTS
	INTERNAL_ERROR
}

enum PairingMode {
	CHAT
	MANAGE
}

type PairingProgressNotice {
	verificationCode: String
	deviceId: ID!
	deviceName: String!
	error: PairingErrorCode
}

type PairingRequestNotice {
	fromIp: String!
	fromId: ID!
	fromName: String!
	deviceType: DeviceType!
	verificationCode: String!
	identityChanged: Boolean!
}

type Peer {
	id: ID!
	name: String!
	ip: String!
	status: PeerStatus!
	port: Int
	deviceType: DeviceType!
	createdAt: Instant!
	updatedAt: Instant!
	online: Boolean!
	managed: Boolean!
	key: String!
	publicKey: String!
	token: String!
}

enum PeerStatus {
	PAIRED
	UNPAIRED
	CHANNEL
}

Operazioni

subscription

peersChanged

Ricevere un segnale quando cambiano i record dei peer.

graphql
subscription peersChanged {
  peersChanged
}
subscription

pairingRequested

Ricevere una richiesta di associazione in arrivo in attesa di decisione.

graphql
subscription pairingRequested {
  pairingRequested { fromIp fromId fromName deviceType verificationCode identityChanged }
}
subscription

pairingCompleted

Ricevere una notifica di completamento dell’associazione dei dispositivi.

graphql
subscription pairingCompleted {
  pairingCompleted { deviceId deviceName ip port deviceType requestId }
}
subscription

pairingStarted

Ricevere una notifica di avvio di un tentativo di associazione.

graphql
subscription pairingStarted {
  pairingStarted { verificationCode deviceId deviceName error }
}
subscription

pairingFailed

Ricevere una notifica di fallimento di un tentativo di associazione.

graphql
subscription pairingFailed {
  pairingFailed { verificationCode deviceId deviceName error }
}
subscription

pairingCanceled

Ricevere una notifica di annullamento di un tentativo di associazione.

graphql
subscription pairingCanceled {
  pairingCanceled { verificationCode deviceId deviceName error }
}
mutation

cancelPairing

Annulla l’abbinamento in corso del dispositivo indicato.

graphql
mutation cancelPairing($peerId: ID!) {
  cancelPairing(peerId: $peerId)
}
mutation

deletePeer

Elimina il dispositivo e la cronologia della chat individuale; conserva il record se un canale lo usa ancora.

graphql
mutation deletePeer($peerId: ID!) {
  deletePeer(peerId: $peerId)
}
mutation

pairPeer

Avvia l’abbinamento chat o l’accesso di gestione; true conferma la ricezione.

graphql
mutation pairPeer($peerId: ID!, $input: PairPeerInput!) {
  pairPeer(peerId: $peerId, input: $input)
}
mutation

respondToPairing

Accetta o rifiuta la richiesta di abbinamento o la conferma di fiducia in sospeso del dispositivo.

graphql
mutation respondToPairing($peerId: ID!, $accepted: Boolean!) {
  respondToPairing(peerId: $peerId, accepted: $accepted)
}
mutation

unpairPeer

Annulla l’abbinamento locale e rimuovi l’accesso di gestione mantenendo le chat.

graphql
mutation unpairPeer($peerId: ID!) {
  unpairPeer(peerId: $peerId)
}
query

peerFileUrl

Crea un URL di download con l’indirizzo attualmente salvato del dispositivo.

graphql
query peerFileUrl($peerId: ID!, $fileId: String!) {
  peerFileUrl(peerId: $peerId, fileId: $fileId)
}
query

peers

Elenca tutti i dispositivi salvati, abbinati, non abbinati o usati solo dai canali.

graphql
query peers {
  peers { id name ip status port deviceType createdAt updatedAt }
}