Skip to content

REST API

Version: 11.0.u2011.0.u1110.0.u3210.0.u3110.0.u2010.0.u1110.0.u109.0.u409.0.u509.0.u309.0.u209.0.u128.0.u418.0.u308.0.u208.0.u107.0.0.u327.0.0.u317.0.0.u30Download

×

  • REST API Directory
  • Product introduction
    • Total Control overview
    • Total Control REST API introduction
    • Usage notice
  • Preparation before study
    • Programming language
    • Code editor
  • Beginner's guide
    • Install Total Control system
    • Connect phone via Total Control
    • Getting started with Total Control REST API
    • Script executor for Total Control
  • Script usage guide
    • Single device
    • Multi-device
    • Global error code table
    • Compare JavaScript with REST API
    • How to set Show Coordinates in Total Control
    • How to use RingoJS built-in modules in Total Control
    • Introduct REST API parameters of Total Control panel
    • How to create SCP file
    • How to get messages in notification bar
    • How to add custom mothod for device object?
  • Basic authentication [Token]
  • Get the device ID and properties [Device]
    • connectAll:Automatic connection device
    • getMain:Get the main device ID
    • searchObject(tcConst.DevAll): Get all devices
    • searchObject(DeviceName): Get device based on device name
    • searchObject(tcConst.DevGroup, GroupName): Get device based on the group name
    • searchObject(tcConst.DevTag, TagName): Get device based on the tag name
    • get device properties
    • How to use the multi-device REST API
  • Device control interface: [App]
    • closeApp: Close the app
    • getActivity: Get the current activity
    • getForegroundApp: Get the name of the foreground app
    • getInstalledAPKList: Get the list of installed app
    • installApp: Install app
    • restartApp: Restart app
    • runApp: Run app
    • uninstallAPK: Uninstall app
  • Device control interface: [Color]
    • compareColor: Compare color
    • compareColorEx: (overload 1)Compare the colors of multiple coordinate points
    • compareColorEx: (overload 2)Compare the colors of multiple coordinate points
    • getColorBits: Get the screen color depth
    • getColorCount: Get the number of colors in the specified area
    • getPixelColor: Get the pixel color
    • seekColor: Seeking the specified color
  • Device control interface: [Image]
    • screenshot: Screen capture to computer
    • screenshotToDevice: Screen capture to device
    • screenshotToMemory: Screen capture to memory
    • seekImage: Seek image
    • seekImage: (overload 1)Seek image
    • seekImage: (Overload 2) Seek image in the specificarea of the screen
    • seekImageByID: Seek image by ID
    • getData Get image data
    • clearMemslot: Clear data in Memslot
  • Device control interface: [Input]
    • click: Send a click event
    • scroll: Scroll the screen
    • send: Send a phone button event
    • shift: Send a transfer event
    • swipe: Send a swipe event
    • move: Move pages according to system settings
  • Device control interface: [OCR]
    • analyzeText: Analyze text
  • Device control interface: [System]
    • exec: Execute the commands
    • get: Get device properties
    • getNotification: Get the notification
    • set: Set device properties
    • setName: Set device name
    • lock/unlock: Unlock/lock the TC control interface
    • run JS API via POST
  • Device control interface: [Text]
    • inputText: Text input
    • inputForm: Text input
    • getClipboardText: Get the content from the clipboard
  • Public interface: [Script]
    • scriptKill: Stop the script
    • scriptList:Get a list of scripts
    • scriptRun: Run the script file
    • scriptWait: Get the status of the script
  • Public interface: [File]
    • Upload file
    • Download specified file
    • Get information for the specified file
  • Public interface: [Task]
    • taskCreate: Create a task
    • taskDelete: Delete the task
    • taskInfo: Get the details of the task
    • taskList: Get task list
    • taskPause: Pause the task
    • taskResume: Resume the task
    • taskStop: Stop the task
    • taskSet: Set task parameters
  • AAI interface: [UI component]
    • sendAai
    • getSetting: Get AAI Settings
    • clickSync: Click the UI component
    • inputTextSync: Text input
    • runAppSync: Run or restart the specified App
  • Public interface: [System]
    • Get storage area
    • Get the version
  • Rest API extension function (call JS API)
    • How to call JS API through Rest API

REST API directory

Product Introduction
Preparation before study
Beginner's guide
Script usage guide
Basic authentication [Token]
Get the device ID and properties [Device]
Device control interface: [APP]
Device control interface: [Color]
Device control interface: [Image]
Device control interface: [Input]
Device control interface: [OCR]
Device control interface: [System]
Device control interface: [Text]
Public interface: [Script]
Public interface: [File]
Public interface: [Task]
Public interface: [System]

TCHelp

TCHelp

No search results. Send this question to us.

Sigma RT Total Control Documentation