API-Referenz

Kopplung

Funktionsunterstützung über app.capabilities prüfen, Autorisierung über app.access und Host-Berechtigungen. Die Beispiele verwenden synthetische Werte; vor dem Aufruf Pfade, IDs, Eingaben und Filter ersetzen.

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

QR

QR payload

QR: A zeigt den Code, B scannt ihn. Im LAN identifiziert c-id den Sender; BLE verwendet seinen eigenen Transport. PAIR_CANCEL ist optional.

Feld mit der Maus oder durch Antippen öffnen
1 / 2

Synthetischer Schnappschuss zu einem festen Zeitpunkt; Signaturen und requestIds stimmen überein. 192.0.2.0/24 ist für Dokumentation reserviert. 8443 ist der Standard-HTTPS-Port; tatsächliche Anfragen verwenden den erkannten Port. Diese zeitlich begrenzten Anfragen können nicht unverändert wiederholt werden.

Wenn Sie in PlainApp Desktop ein neues Gerät oder ein Gerät mit geändertem öffentlichem Schlüssel verwalten, müssen Sie ihm zuerst ausdrücklich vertrauen. Dieser Schritt zeigt keinen Vergleichscode; bei einer Schlüsseländerung erscheint eine Warnung. Ohne Passwort vergleichen Sie anschließend den einen Code auf beiden Geräten, bevor Sie auf dem anderen Gerät zustimmen. Bei Anmeldung mit Passwort kann das andere Gerät auch ohne Code um Zustimmung bitten.

Typdefinitionen

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
}

Operationen

subscription

peersChanged

Empfängt ein Änderungssignal bei geänderten Gerätedatensätzen.

graphql
subscription peersChanged {
  peersChanged
}
subscription

pairingRequested

Empfängt eine eingehende Kopplungsanfrage, über die entschieden werden muss.

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

pairingCompleted

Empfängt eine Benachrichtigung über eine abgeschlossene Gerätekopplung.

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

pairingStarted

Empfängt eine Benachrichtigung über einen gestarteten Kopplungsversuch.

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

pairingFailed

Empfängt eine Benachrichtigung über einen fehlgeschlagenen Kopplungsversuch.

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

pairingCanceled

Empfängt eine Benachrichtigung über einen abgebrochenen Kopplungsversuch.

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

cancelPairing

Aktuelle Kopplung des angegebenen Geräts abbrechen.

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

deletePeer

Gerät und Einzelchatverlauf löschen; bei Kanalverweisen bleibt ein Kanaldatensatz erhalten.

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

pairPeer

Chatkopplung oder Verwaltungsanmeldung starten; true bestätigt die Annahme.

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

respondToPairing

Ausstehende Kopplungsanfrage oder Vertrauensbestätigung des Geräts annehmen oder ablehnen.

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

unpairPeer

Lokal entkoppeln und Verwaltungszugriff entfernen; Chatverlauf behalten.

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

peerFileUrl

Download-URL mit der aktuell gespeicherten Geräteadresse erstellen.

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

peers

Alle gespeicherten Geräte auflisten, einschließlich gekoppelter, entkoppelter und reiner Kanalgeräte.

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