Référence de l'API

Application

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.

Définitions de types

graphql
type Mutation {
  clearAppCache: Boolean!
  restartHttpServer(httpPort: Int, httpsPort: Int): HttpServerState!
  relaunchApp: Boolean!
  requestAccess(feature: AccessFeature!): Boolean!
  setTempValue(key: String!, value: String!): KeyValuePair!
  updateDeviceName(name: String!): Boolean!
}

type Query {
  appCacheSize: Long!
  appUpdate: AppUpdate!
  httpServer: HttpServer!
  app: App!
}

type Subscription {
  httpServerChanged: HttpServer!
  deviceNameUpdated: String!
  accessUpdated: Boolean!
  contentChanged: Boolean!
}

enum AccessFeature {
	IMAGES
	VIDEOS
	AUDIO
	DOCS
	FILES
	CONTACTS
	SMS
	CALLS
	CALL_PHONE
	PHONE_NUMBER
	APPS
	NOTIFICATIONS
	CLIPBOARD
	ADB
}

type App {
	clientId: ID!
	httpPort: Int!
	httpsPort: Int!
	deviceName: String!
	developerMode: Boolean!
	urlToken: String!
	tlsCertificateSha256: String
	appDir: String!
	deviceType: DeviceType!
	capabilities: [Capability!]!
	buildChannel: AppChannelType!
	access: [AccessFeature!]!
	downloadsDir: String!
	debug: Boolean!
}

enum AppChannelType {
	GITHUB
	GOOGLE
	FDROID
}

type AppUpdate {
	currentVersion: String!
	latestVersion: String
	releaseName: String!
	publishedAt: Instant
	hasUpdate: Boolean!
	url: String
}

enum Capability {
	ADB
	BLE
	WIFI_AWARE
	APP_RELAUNCH
	MEDIA_TRASH
	MEDIA_DELETE
	MEDIA_MOVE
	MEDIA_FAVORITE
	APP_UPDATES
	MIRROR_AUDIO
	MEDIA_SCAN
	TELEPHONY
	PACKAGES
	SCREEN_MIRROR
	NOTIFICATIONS
	CLIPBOARD
	DISK_MANAGER
	HTTP_SERVER
}

enum DeviceType {
	COMPUTER
	PHONE
	TABLET
	TV
	NAS
	OTHER
}

type HttpServer {
	state: HttpServerState!
	addresses: [String!]!
	onlineClients: [ID!]!
	remoteAccess: Boolean!
	mdnsHostname: String!
}

type HttpServerState {
	revision: Long!
	restarting: Boolean!
	httpPort: Int!
	httpsPort: Int!
	error: String!
}

scalar Instant

type KeyValuePair {
	key: String!
	value: String!
}

scalar Long

Opérations

mutation

clearAppCache

Supprimer les fichiers temporaires du cache de l’application.

graphql
mutation clearAppCache {
  clearAppCache
}
mutation

restartHttpServer

Modifier les ports HTTP/HTTPS et attendre que les nouveaux écouteurs soient prêts. Nécessite HTTP_SERVER. Renvoie les ports effectifs ; reconnectez-vous si l’adresse actuelle change.

graphql
mutation restartHttpServer($httpPort: Int, $httpsPort: Int) {
  restartHttpServer(httpPort: $httpPort, httpsPort: $httpsPort) { revision restarting httpPort httpsPort error }
}
query

appCacheSize

Renvoyer l’espace occupé par le cache de l’application en octets.

graphql
query appCacheSize {
  appCacheSize
}
query

appUpdate

Lire les informations disponibles sur les mises à jour de l’application.

graphql
query appUpdate {
  appUpdate { currentVersion latestVersion releaseName publishedAt hasUpdate url }
}
query

httpServer

Lire l’état HTTP/HTTPS, les adresses du réseau local, les clients connectés et l’accès distant. Nécessite un appelant authentifié et HTTP_SERVER.

graphql
query httpServer {
  httpServer { addresses onlineClients remoteAccess mdnsHostname }
}
subscription

httpServerChanged

Recevez l’état actuel du serveur HTTP à l’abonnement et après toute modification des points d’écoute, du réseau, des clients connectés ou des préférences. Nécessite un appelant authentifié et la prise en charge de HTTP_SERVER. Annulez l’abonnement en quittant la page et réabonnez-vous au retour.

graphql
subscription httpServerChanged {
  httpServerChanged { addresses onlineClients remoteAccess mdnsHostname }
}
subscription

deviceNameUpdated

Recevoir le nom d’affichage actualisé de l’appareil.

graphql
subscription deviceNameUpdated {
  deviceNameUpdated
}
subscription

accessUpdated

Recevoir un signal lorsque l’autorisation des fonctionnalités de l’appareil change.

graphql
subscription accessUpdated {
  accessUpdated
}
subscription

contentChanged

Recevoir un signal lorsque le contenu enregistré change.

graphql
subscription contentChanged {
  contentChanged
}
mutation

relaunchApp

Redémarrer le processus PlainApp sur l’appareil.

graphql
# The app restarts itself; the response only acknowledges that the
# request was accepted, since the connection dies with the process.
mutation relaunchApp {
  relaunchApp
}
mutation

requestAccess

Demander l’autorisation de l’appareil pour une fonctionnalité prise en charge ; une intervention de l’utilisateur sur l’appareil peut être nécessaire.

graphql
mutation requestAccess($feature: AccessFeature!) {
  requestAccess(feature: $feature)
}
mutation

setTempValue

Définir puis renvoyer une paire clé/valeur temporaire en mémoire ; il ne s’agit pas de données Key Value persistantes.

graphql
mutation setTempValue($key: String!, $value: String!) {
  setTempValue(key: $key, value: $value) { key value }
}
mutation

updateDeviceName

Modifier le nom de l’appareil affiché dans l’interface web et diffusé aux pairs associés.

graphql
# Renaming the device also re-publishes the mDNS advertisement, so a
# client that waits for the new name to appear does see it.
mutation updateDeviceName($name: String!) {
  updateDeviceName(name: $name)
}
query

app

Lire l’identité, la configuration, les capacités et les autorisations de l’application. app.urlToken appartient à la session appelante et chiffre les liens vers les ressources ; ce n’est pas le jeton d’authentification GraphQL.

graphql
# Everything a client needs to reach this device: its identity, the
# port it listens on and the token that authorises it.
query app {
  app { clientId httpPort httpsPort deviceName developerMode urlToken tlsCertificateSha256 appDir }
}