PlainApp
Referência da API

Associação

Verificar app.capabilities para o suporte de funcionalidades e app.access juntamente com as permissões do anfitrião para autorização. Os exemplos usam valores sintéticos; substituir caminhos, ID, entradas e filtros antes da chamada.

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

QR

QR payload

QR: A apresenta, B lê. Na LAN, c-id identifica o emissor; BLE usa o seu próprio transporte. PAIR_CANCEL é opcional.

Passar o cursor ou tocar num campo
1 / 2

Instantâneo sintético num momento fixo; as assinaturas e os requestIds correspondem. 192.0.2.0/24 está reservado para documentação. 8443 é a porta HTTPS predefinida; usar a porta descoberta nos pedidos reais. Estes pedidos com validade limitada não podem ser repetidos tal como estão.

No PlainApp Desktop, para gerenciar um dispositivo novo ou cuja chave pública mudou, confirme explicitamente que você confia nele. Essa etapa não exibe código de comparação; se a chave mudou, aparece um aviso. Se você não usou senha, compare o código exibido nos dois dispositivos antes de aprovar no outro dispositivo. Com a autenticação por senha, o outro dispositivo pode pedir aprovação sem exibir um código.

Definições de 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
}

Operações

subscription

peersChanged

Receber um sinal quando os registos de pares mudarem.

graphql
subscription peersChanged {
  peersChanged
}
subscription

pairingRequested

Receber um pedido de associação pendente de decisão.

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

pairingCompleted

Receber uma notificação de conclusão da associação de dispositivos.

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

pairingStarted

Receber uma notificação do início de uma tentativa de associação.

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

pairingFailed

Receber uma notificação de falha de uma tentativa de associação.

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

pairingCanceled

Receber uma notificação de cancelamento de uma tentativa de associação.

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

cancelPairing

Cancelar o emparelhamento atual do dispositivo indicado.

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

deletePeer

Excluir o dispositivo e o histórico de conversa individual; manter o registro se um canal ainda o referenciar.

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

pairPeer

Iniciar emparelhamento de chat ou acesso de gerenciamento; true confirma o recebimento.

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

respondToPairing

Aceitar ou rejeitar o pedido de emparelhamento ou a confirmação de confiança pendente do dispositivo.

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

unpairPeer

Desemparelhar localmente e remover o acesso de gerenciamento, mantendo as conversas.

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

peerFileUrl

Criar uma URL de download com o endereço atualmente salvo do dispositivo.

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

peers

Listar todos os dispositivos salvos, emparelhados, desemparelhados ou usados apenas por canais.

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