API Referansı

Eşleştirme

Özellik desteği için app.capabilities, yetkilendirme için app.access ve ana makine izinlerini kontrol edin. Çağrıdan önce örnek değerleri değiştirin.

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

QR

QR payload

QR: A gösterir, B tarar. LAN c-id göndereni tanımlar; BLE kendi aktarımını kullanır. PAIR_CANCEL isteğe bağlıdır.

Alanın üzerine gelin veya dokunun
1 / 2

Sabit zamandaki sentetik anlık görüntü; imzalar ve requestIds eşleşir. 192.0.2.0/24 belgelere ayrılmıştır. 8443 varsayılan HTTPS portudur; gerçek isteklerde keşfedilen portu kullanın. Bu zaman sınırlı istekler aynen yeniden oynatılamaz.

PlainApp Desktop’ta yeni bir cihazı ya da açık anahtarı değişmiş bir cihazı yönetmeden önce ona güvendiğinizi açıkça onaylayın. Bu adımda karşılaştırma kodu gösterilmez; anahtar değişmişse uyarı gösterilir. Parola kullanmadıysanız, diğer cihazda onay vermeden önce iki cihazda görünen kodun aynı olduğunu kontrol edin. Parolayla doğrulama yaptıysanız, diğer cihaz kod göstermeden de onay isteyebilir.

Tip Tanımları

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
}

İşlemler

subscription

peersChanged

Eş kayıtları değiştiğinde değişiklik sinyali alır.

graphql
subscription peersChanged {
  peersChanged
}
subscription

pairingRequested

Karar bekleyen gelen eşleştirme isteğini alır.

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

pairingCompleted

Cihaz eşleştirmesinin tamamlandığı bildirimini alır.

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

pairingStarted

Eşleştirme denemesinin başladığı bildirimini alır.

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

pairingFailed

Eşleştirme denemesinin başarısız olduğu bildirimini alır.

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

pairingCanceled

Eşleştirme denemesinin iptal edildiği bildirimini alır.

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

cancelPairing

Belirtilen cihazın devam eden eşleştirmesini iptal eder.

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

deletePeer

Cihazı ve bire bir sohbet geçmişini siler; bir kanal hâlâ kullanıyorsa kanal kaydını korur.

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

pairPeer

Sohbet eşleştirmesini veya yönetim girişini başlatır; true isteğin alındığını belirtir.

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

respondToPairing

Cihazın bekleyen eşleştirme isteğini veya güven onayını kabul eder ya da reddeder.

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

unpairPeer

Yerel eşleştirmeyi kaldırır ve yönetim erişimini temizler; sohbet geçmişini korur.

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

peerFileUrl

Cihazın güncel kayıtlı adresiyle dosya indirme URL’si oluşturur.

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

peers

Eşleştirilmiş, eşleştirilmemiş ve yalnızca kanalların kullandığı tüm kayıtlı cihazları listeler.

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