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