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.
plainapp://pair?request=<URL-encoded JSON>QR
signature = Base64(Ed25519-Sign(Device A private key, signed))Ed25519-Verify(Device A public key, signed, Base64Decode(signature))Abrir o segmento JSON para consultar a entrada assinada completa deste exemplo sintético; o destinatário verifica com a chave pública do signatário.verificationCode = 73939800digest = SHA256(request.signature encoded as UTF-8)digest (hex) = ff44f60497bc235899f050f272165ec094a2f2c685e776d153a0711424b85dc0number = first 8 digest bytes as an unsigned big-endian integerverificationCode = number mod 100000000, padded to 8 decimal digitsQR: A apresenta, B lê. Na LAN, c-id identifica o emissor; BLE usa o seu próprio transporte. PAIR_CANCEL é opcional.
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
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
peersChanged
Receber um sinal quando os registos de pares mudarem.
subscription peersChanged {
peersChanged
}pairingRequested
Receber um pedido de associação pendente de decisão.
subscription pairingRequested {
pairingRequested { fromIp fromId fromName deviceType verificationCode identityChanged }
}pairingCompleted
Receber uma notificação de conclusão da associação de dispositivos.
subscription pairingCompleted {
pairingCompleted { deviceId deviceName ip port deviceType requestId }
}pairingStarted
Receber uma notificação do início de uma tentativa de associação.
subscription pairingStarted {
pairingStarted { verificationCode deviceId deviceName error }
}pairingFailed
Receber uma notificação de falha de uma tentativa de associação.
subscription pairingFailed {
pairingFailed { verificationCode deviceId deviceName error }
}pairingCanceled
Receber uma notificação de cancelamento de uma tentativa de associação.
subscription pairingCanceled {
pairingCanceled { verificationCode deviceId deviceName error }
}cancelPairing
Cancelar o emparelhamento atual do dispositivo indicado.
mutation cancelPairing($peerId: ID!) {
cancelPairing(peerId: $peerId)
}deletePeer
Excluir o dispositivo e o histórico de conversa individual; manter o registro se um canal ainda o referenciar.
mutation deletePeer($peerId: ID!) {
deletePeer(peerId: $peerId)
}pairPeer
Iniciar emparelhamento de chat ou acesso de gerenciamento; true confirma o recebimento.
mutation pairPeer($peerId: ID!, $input: PairPeerInput!) {
pairPeer(peerId: $peerId, input: $input)
}respondToPairing
Aceitar ou rejeitar o pedido de emparelhamento ou a confirmação de confiança pendente do dispositivo.
mutation respondToPairing($peerId: ID!, $accepted: Boolean!) {
respondToPairing(peerId: $peerId, accepted: $accepted)
}unpairPeer
Desemparelhar localmente e remover o acesso de gerenciamento, mantendo as conversas.
mutation unpairPeer($peerId: ID!) {
unpairPeer(peerId: $peerId)
}peerFileUrl
Criar uma URL de download com o endereço atualmente salvo do dispositivo.
query peerFileUrl($peerId: ID!, $fileId: String!) {
peerFileUrl(peerId: $peerId, fileId: $fileId)
}peers
Listar todos os dispositivos salvos, emparelhados, desemparelhados ou usados apenas por canais.
query peers {
peers { id name ip status port deviceType createdAt updatedAt }
}