App

API リファレンス

デバイスとアプリの情報の取得、クリップボードの設定、アプリの再起動、デバイスレベルの設定の管理を行います。お気に入りフォルダのミューテーションは Files セクションに記載されています。

型定義

bash

type App {
  usbConnected: Boolean!
  urlToken: String!              # current session token
  httpPort: Int!
  httpsPort: Int!
  appDir: String!
  deviceName: String!
  battery: Int!                  # battery level 0–100
  appVersion: Int!               # versionCode
  osVersion: Int!                # Android SDK level e.g. 35
  channel: String!               # "github" | "google"
  permissions: [String!]!        # granted API permissions
  audios: [PlaylistAudio!]!      # current playlist
  audioMode: MediaPlayMode!      # REPEAT | REPEAT_ONE | SHUFFLE
  audioCurrent: String!          # path of the playing track
  sdcardPath: String!
  usbDiskPaths: [String!]!
  internalStoragePath: String!
  downloadsDir: String!
  developerMode: Boolean!
  favoriteFolders: [FavoriteFolder!]!
}

type FavoriteFolder {
  rootPath: String!
  fullPath: String!
  alias: String              # optional display alias, nullable
}

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

type DeviceInfo {
  # Hardware + OS info: manufacturer, model, sdkInt, buildChannel, etc.
  # Fields are platform-dependent; see PlainApp source for the full list.
}

type Battery {
  level: Int!                # 0–100
  status: BatteryStatus!     # CHARGING | DISCHARGING | FULL | NOT_CHARGING
  health: BatteryHealth!
  plugged: BatteryPlugged!
  temperature: Int!          # tenths of a degree Celsius
  voltage: Int!              # millivolts
}

enum BatteryStatus   { CHARGING DISCHARGING FULL NOT_CHARGING UNKNOWN }
enum BatteryHealth   { GOOD OVERHEAT DEAD OVER_VOLTAGE UNSPECIFIED_FAILURE UNKNOWN COLD }
enum BatteryPlugged  { AC USB WIRELESS NONE }

操作

query

app

1 回のクエリですべてのデバイスとアプリの状態を取得します。

bash

query GetApp {
  app {
    usbConnected urlToken httpPort httpsPort appDir deviceName
    battery appVersion osVersion channel permissions
    audios { title path duration } audioMode audioCurrent
    sdcardPath usbDiskPaths internalStoragePath downloadsDir developerMode
    favoriteFolders { rootPath fullPath alias }
  }
}

query

deviceInfo

ハードウェアと OS の情報 (製造元、モデル、SDK レベルなど) を取得します。

bash

query GetDeviceInfo {
  deviceInfo { manufacturer model sdkInt buildChannel }
}

query

battery

現在のバッテリーレベル、充電状態、健康状態、電圧を取得します。

bash

query GetBattery {
  battery { level status health plugged temperature voltage }
}

mutation

setTempValue

サーバーメモリに一時的なキー/値のペアを設定します。HTTP サーバーの再起動時にクリアされます。

bash

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

mutation

relaunchApp

デバイス上で PlainApp プロセスを再起動します。

bash

mutation RelaunchApp {
  relaunchApp
}

mutation

openAccessibilitySettings

デバイスで Android アクセシビリティ設定画面を開きます。sendScreenMirrorControl がジェスチャーをディスパッチできるようになる前に必要です。

bash

mutation OpenAccessibilitySettings {
  openAccessibilitySettings
}

mutation

openWebSettings

デバイスで PlainApp web-UI 設定画面 (パスワード、2FA など) を開きます。

bash

mutation OpenWebSettings {
  openWebSettings
}

mutation

setClip

デバイスのクリップボードを指定したテキストに設定します。

bash

mutation SetClip($text: String!) {
  setClip(text: $text)
}

mutation

updateDeviceName

web UI に表示され、ペアリングされた peers にブロードキャストされるデバイス表示名を変更します。

bash

mutation UpdateDeviceName($name: String!) {
  updateDeviceName(name: $name)
}