Справочник API

Связывание

Поддержку функций проверяйте через app.capabilities, доступ — через app.access и разрешения хоста. Замените тестовые значения перед вызовом.

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

QR

QR payload

QR: A показывает, B сканирует. c-id в LAN определяет отправителя; BLE использует свой транспорт. PAIR_CANCEL необязателен.

Наведите указатель на поле или коснитесь его
1 / 2

Искусственный снимок на фиксированный момент; подписи и requestIds согласованы. 192.0.2.0/24 зарезервирован для документации. 8443 — порт HTTPS по умолчанию; в реальных запросах используйте обнаруженный порт. Эти ограниченные по времени запросы нельзя повторить без изменений.

В PlainApp Desktop перед управлением новым устройством или устройством с изменившимся открытым ключом явно подтвердите, что доверяете ему. На этом этапе код не отображается, но при смене ключа появляется предупреждение. Если пароль не использовался, сравните код на обоих устройствах и только затем подтвердите запрос на другом устройстве. При использовании пароля другое устройство может запросить подтверждение, не показывая код.

Определения типов

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
}

Операции

subscription

peersChanged

Получает сигнал при изменении записей узлов.

graphql
subscription peersChanged {
  peersChanged
}
subscription

pairingRequested

Получает входящий запрос сопряжения, ожидающий решения.

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

pairingCompleted

Получает уведомление о завершении сопряжения устройств.

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

pairingStarted

Получает уведомление о начале попытки сопряжения.

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

pairingFailed

Получает уведомление о неудачной попытке сопряжения.

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

pairingCanceled

Получает уведомление об отмене попытки сопряжения.

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

cancelPairing

Отменить текущее сопряжение указанного устройства.

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

deletePeer

Удалить устройство и историю личного чата; сохранить запись, если на неё ещё ссылается канал.

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

pairPeer

Начать сопряжение для чата или вход для управления; true означает принятие запроса.

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

respondToPairing

Принять или отклонить ожидающий запрос сопряжения или подтверждение доверия устройства.

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

unpairPeer

Отменить сопряжение локально и убрать доступ к управлению, сохранив историю чата.

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

peerFileUrl

Создать ссылку на скачивание по текущему сохранённому адресу устройства.

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

peers

Показать все сохранённые устройства: сопряжённые, несопряжённые и используемые только каналами.

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