Référence de l'API

Découverte à proximité

Vérifier app.capabilities pour la prise en charge des fonctionnalités et app.access ainsi que les permissions de l’hôte pour les autorisations. Les exemples utilisent des valeurs synthétiques ; remplacer les chemins, ID, entrées et filtres avant tout appel.

Device A
UDP → 224.0.0.251:5353
Device B

PTR query

UDP · DNS

Multicast IPv4, pas une diffusion IP : 224.0.0.251:5353. A recherche toutes les 5 s ; B s’annonce aussi au démarrage et toutes les 60 s. Les réponses PTR incluent SRV, TXT et A. Les fenêtres contextuelles affichent des enregistrements DNS synthétiques décodés.

Survoler ou toucher un champ
1 / 3

Définitions de types

graphql
type Mutation {
  acquireMdnsDebugSession(token: String!): Boolean!
  releaseMdnsDebugSession(token: String!): Boolean!
  startDiscovery: Boolean!
  stopDiscovery: Boolean!
}

type Query {
  isDiscovering: Boolean!
  mdnsState: MdnsState!
  nearbyDevices: [NearbyDevice!]!
  parsePairingQrCode(code: String!): NearbyDevice
}

enum DeviceType {
	COMPUTER
	PHONE
	TABLET
	TV
	NAS
	OTHER
}

enum DiscoveryMethod {
	LAN
	BLE
	QR
}

scalar Instant

scalar Long

type MdnsActivity {
	time: Instant!
	event: String!
	detail: String!
}

type MdnsPacket {
	time: Instant!
	direction: MdnsPacketDirection!
	srcIp: String!
	srcPort: Int!
	dstIp: String!
	dstPort: Int!
	size: Long!
	summary: String!
	detail: String!
}

enum MdnsPacketDirection {
	IN
	OUT
}

type MdnsService {
	serviceType: String!
	instanceName: String!
	instanceFqdn: String!
	hostname: String!
	port: Int!
	txtRecords: [String!]!
	ips: [String!]!
	ip6s: [String!]!
	complete: Boolean!
}

type MdnsState {
	runtimeId: String!
	packetsIn: [MdnsPacket!]!
	packetsOut: [MdnsPacket!]!
	revision: Long!
	running: Boolean!
	scanning: Boolean!
	services: [MdnsService!]!
	activity: [MdnsActivity!]!
}

type NearbyDevice {
	id: ID!
	name: String!
	ips: [String!]!
	port: Int!
	remoteAccess: Boolean
	signaturePublicKey: String!
	deviceType: DeviceType!
	version: String!
	platform: String!
	discoveryMethods: [DiscoveryMethod!]!
	bestIp: String!
	status: PeerStatus!
	lastSeen: Instant!
}

enum PeerStatus {
	PAIRED
	UNPAIRED
	CHANNEL
}

Opérations

mutation

acquireMdnsDebugSession

Obtenir une session de débogage mDNS avec un jeton UUID de l’appelant. Nécessite HTTP_SERVER ; libérer la session à la fermeture de la page.

graphql
mutation acquireMdnsDebugSession($token: String!) {
  acquireMdnsDebugSession(token: $token)
}
mutation

releaseMdnsDebugSession

Libérer la session de débogage mDNS avec le jeton correspondant. Nécessite HTTP_SERVER.

graphql
mutation releaseMdnsDebugSession($token: String!) {
  releaseMdnsDebugSession(token: $token)
}
mutation

startDiscovery

Démarrer la découverte d’appareils.

graphql
mutation startDiscovery {
  startDiscovery
}
mutation

stopDiscovery

Arrêter la découverte d’appareils.

graphql
mutation stopDiscovery {
  stopDiscovery
}
query

isDiscovering

Indiquer si une recherche d’appareils est en cours.

graphql
query isDiscovering {
  isDiscovering
}
query

mdnsState

Lire l’état actuel de découverte mDNS et les détails sélectionnés de services ou de paquets.

graphql
query mdnsState {
  mdnsState { runtimeId revision running scanning }
}
query

nearbyDevices

Lister les appareils à proximité actuellement connus et disponibles pour la découverte ou l’association.

graphql
query nearbyDevices {
  nearbyDevices { id name ips port remoteAccess signaturePublicKey deviceType version }
}
query

parsePairingQrCode

Décoder un code d’association valide en informations de connexion d’un appareil à proximité.

graphql
query parsePairingQrCode($code: String!) {
  parsePairingQrCode(code: $code) { id name ips port remoteAccess signaturePublicKey deviceType version }
}