API রেফারেন্স

পেয়ারিং

সমর্থনের জন্য app.capabilities এবং অনুমতির জন্য app.access ও হোস্টের অনুমতি দেখুন। ব্যবহারের আগে নমুনা মান বদলান।

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