PlainApp
API குறிப்பு

இணைத்தல்

அம்ச ஆதரவிற்கு app.capabilities-ஐயும் அனுமதிக்கு app.access மற்றும் host அனுமதிகளையும் சரிபார்க்கவும். எடுத்துக்காட்டுகள் செயற்கை மதிப்புகளைப் பயன்படுத்துகின்றன; அழைப்பதற்கு முன் பாதைகள், 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 port; உண்மைக் கோரிக்கைகளில் கண்டறியப்பட்ட port-ஐப் பயன்படுத்தவும். நேர வரம்புள்ள இக்கோரிக்கைகளை அப்படியே மீண்டும் பயன்படுத்த முடியாது.

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