API संदर्भ

युग्मन

सुविधा समर्थन के लिए app.capabilities और प्राधिकरण के लिए app.access तथा होस्ट अनुमतियाँ जाँचें। उदाहरण कृत्रिम मान उपयोग करते हैं; कॉल करने से पहले पथ, ID, इनपुट और फ़िल्टर बदलें।

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

QR

QR payload

QR: A दिखाता है, B स्कैन करता है। LAN c-id प्रेषक पहचानता है; 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

डिवाइस के वर्तमान सहेजे गए पते से फ़ाइल डाउनलोड URL बनाएँ।

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 }
}