PlainApp
API குறிப்பு

செயலி

அம்ச ஆதரவிற்கு app.capabilities-ஐயும் அனுமதிக்கு app.access மற்றும் host அனுமதிகளையும் சரிபார்க்கவும். எடுத்துக்காட்டுகள் செயற்கை மதிப்புகளைப் பயன்படுத்துகின்றன; அழைப்பதற்கு முன் பாதைகள், ID-கள், உள்ளீடுகள் மற்றும் வடிப்பான்களை மாற்றவும்.

வகை வரையறைகள்

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

செயல்பாடுகள்

mutation

clearAppCache

அகற்றக்கூடிய செயலிக் கேச் கோப்புகளை நீக்கவும்.

graphql
mutation clearAppCache {
  clearAppCache
}
mutation

restartHttpServer

HTTP/HTTPS போர்ட்களை மாற்றி புதிய கேட்பான்கள் தயாராகும் வரை காத்திருக்கவும். HTTP_SERVER தேவை. உண்மையான போர்ட்கள் வழங்கப்படும்; தற்போதைய முகவரி மாறினால் மீண்டும் இணைக்கவும்.

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

appCacheSize

செயலிக் கேச் பயன்பாட்டைப் பைட்டுகளில் தரவும்.

graphql
query appCacheSize {
  appCacheSize
}
query

appUpdate

கிடைக்கக்கூடிய செயலிப் புதுப்பிப்புத் தகவலைப் படிக்கவும்.

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

httpServer

HTTP/HTTPS நிலை, LAN முகவரிகள், இணைந்த வாடிக்கையாளர்கள் மற்றும் தொலைநிலை அணுகல் நிலையைப் படிக்கவும். அங்கீகரிக்கப்பட்ட அழைப்பாளரும் HTTP_SERVER வசதியும் தேவை.

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

httpServerChanged

சந்தா தொடங்கும்போதும், கேட்பான், பிணையம், இணைந்த வாடிக்கையாளர்கள் அல்லது அமைப்புகள் மாறிய பிறகும் HTTP சேவையகத்தின் தற்போதைய நிலையைப் பெறுங்கள். அங்கீகரிக்கப்பட்ட அழைப்பாளரும் HTTP_SERVER ஆதரவும் தேவை. பக்கத்தை விட்டு வெளியேறும்போது சந்தாவை ரத்துசெய்து, திரும்பும்போது மீண்டும் சந்தா சேருங்கள்.

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

deviceNameUpdated

புதுப்பிக்கப்பட்ட சாதனக் காட்சிப் பெயரைப் பெறவும்.

graphql
subscription deviceNameUpdated {
  deviceNameUpdated
}
subscription

accessUpdated

சாதன அம்ச அனுமதி மாறும்போது மாற்றச் சைகையைப் பெறவும்.

graphql
subscription accessUpdated {
  accessUpdated
}
subscription

contentChanged

சேமிக்கப்பட்ட உள்ளடக்கம் மாறும்போது மாற்றச் சைகையைப் பெறவும்.

graphql
subscription contentChanged {
  contentChanged
}
mutation

relaunchApp

சாதனத்தில் PlainApp செயல்முறையை மறுதொடங்கவும்.

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

ஆதரிக்கப்படும் அம்சத்திற்குச் சாதன அனுமதி கோரவும்; சாதனத்தில் பயனர் செயல் தேவைப்படலாம்.

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

setTempValue

நினைவகத்தில் தற்காலிக விசை/மதிப்பு இணையை அமைத்துத் தரவும்; இது நிலையான Key Value தரவு அல்ல.

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

updateDeviceName

இணைய UI-இல் காட்டப்பட்டு இணைக்கப்பட்ட பியர்களுக்கு அறிவிக்கப்படும் சாதனக் காட்சிப் பெயரை மாற்றவும்.

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

செயலி அடையாளம், அமைப்பு, திறன் மற்றும் அனுமதிப் புலங்களைப் படிக்கவும். app.urlToken அழைக்கும் அமர்வைச் சேர்ந்தது; வள இணைப்புகளை மறைகுறியாக்குகிறது, 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 }
}