Xgodo API Documentation

Returns:

Promise<void>

 - Promise that resolves when navigation is complete

Returns:

Promise<void>

 - Promise that resolves when recents view is opened

Returns:

Promise<void>

 - Promise that resolves when back action is complete

Returns:

Promise<void>

 - Promise that resolves when keyboard is hidden

Returns:

{ id: string, brand: string, model: string, sdkVersion: number, processor: string, numberOfCores: number, ramMb: number, country: string, isEmulator: boolean, width: number, height: number }

 - Device information object

Returns:

Promise<void>

 - Promise that resolves when airplane mode is turned on and then off

Parameters:

• fileName (string): Name of the file to save
• data (string): Content to save in the file
• base64 (boolean): Whether the data is base64 encoded (optional)

Returns:

Promise<void>

 - Promise that resolves when file is saved

Parameters:

• path (string): Path to check

Returns:

boolean

 - true if the path exists, false otherwise

Parameters:

• filePath (string): Path to the file

Returns:

number

 - File size in bytes, or -1 if file doesn't exist or is not a file

Parameters:

• filePath (string): Path to the file

Returns:

string

 - Base64-encoded file content, or empty string if file doesn't exist

Parameters:

• filePath (string): Path to the file

Returns:

string

 - File content as UTF-8 string, or empty string if file doesn't exist

Parameters:

• dirPath (string): Path to the directory

Returns:

FileInfo[]

 - Array of FileInfo objects containing:
- name: File or directory name
- path: Absolute path
- isDirectory: Whether this is a directory
- isFile: Whether this is a file
- size: File size in bytes (0 for directories)
- lastModified: Last modified timestamp in milliseconds
Returns empty array if directory doesn't exist or is not accessible

Parameters:

• path (string): Path to check

Returns:

DirectoryInfo | FilePathInfo | PathNotFoundInfo

 - Path information object:
For directories (DirectoryInfo):
- exists: true
- path, name: Path and name
- isDirectory: true, isFile: false
- lastModified: Timestamp
- canRead, canWrite: Permission flags
- fileCount, directoryCount, totalItems: Content counts

For files (FilePathInfo):
- exists: true
- path, name: Path and name
- isDirectory: false, isFile: true
- lastModified: Timestamp
- canRead, canWrite: Permission flags
- size: File size in bytes

For non-existent paths (PathNotFoundInfo):
- exists: false
- error: Optional error message

Returns:

string

 - Absolute path to storage root, or empty string on error

Parameters:

• filePath (string): Path to the file

Returns:

FileHashes | FileHashError

 - On success (FileHashes):
- md5: MD5 hash in hexadecimal
- sha1: SHA-1 hash in hexadecimal
- sha256: SHA-256 hash in hexadecimal
- size: File size in bytes

On error (FileHashError):
- error: Error message

Parameters:

• base64 (string): Base64-encoded string

Returns:

Uint8Array

 - Byte array representation

Parameters:

• bytes (number[]): Array of bytes
• mimeType (string): MIME type (optional, e.g., 'image/png', 'application/pdf')

Returns:

Blob | null

 - Blob object or null on error

Parameters:

• filePath (string): Path to the file
• mimeType (string): MIME type (optional)

Returns:

Blob | null

 - Blob object or null on error

Parameters:

• intentName (string): Name of the intent
• packageName (string | null): Target package name
• data (string | null): Intent data
• type (string | null): MIME type
• extras (object | null): Extra data for intent
• flags (number): Intent flags
• component ('activity' | 'service' | 'broadcast'): Component type
• isDataLocal (boolean | null): Is the provided data a local file

Parameters:

• url (string): URL to open
• clearExistingData (boolean): Whether to clear existing browser data (optional)

Parameters:

• x1 (number): Left boundary
• y1 (number): Top boundary
• x2 (number): Right boundary
• y2 (number): Bottom boundary

Parameters:

• x1 (number): Left boundary
• y1 (number): Top boundary
• x2 (number): Right boundary
• y2 (number): Bottom boundary
• direction ('up' | 'down' | 'left' | 'right'): Swipe direction

Parameters:

• htmlCode (string): HTML content to display
• x1 (number): Left position
• y1 (number): Top position
• x2 (number): Right position
• y2 (number): Bottom position
• opacity (number): Opacity of the display

Parameters:

• x (number): The x coordinate where the tap should occur
• y (number): The y coordinate where the tap should occur

Returns:

Promise<void>

 - Promise that resolves when tap is complete

Parameters:

• x1 (number): Starting x coordinate
• y1 (number): Starting y coordinate
• x2 (number): Ending x coordinate
• y2 (number): Ending y coordinate
• duration (number): Duration of swipe in milliseconds

Returns:

Promise<void>

 - Promise that resolves when swipe is complete

Parameters:

• x (number): The x coordinate
• y (number): The y coordinate
• duration (number): Duration in milliseconds

Parameters:

• sequence ([number, number][]): Array of coordinate pairs
• intervalFrom (number): Minimum interval between taps
• intervalTo (number): Maximum interval between taps

Parameters:

• startX (number): Starting x coordinate
• startY (number): Starting y coordinate
• sequence ([number, number][]): Path points
• duration (number): Total duration
• bezier (boolean): Use bezier curve interpolation

Parameters:

• text (string): Text to type

Returns:

Promise<void>

 - Promise that resolves when text is written

Returns:

Promise<{ text: string, data: any, files?: { uri: string, mimeType: string, name: string, dataBase64?: string }[] }>

 - The clipboard content including text, raw data dump, and any files with their metadata and base64 encoded data

Returns:

Promise<void>

 - Promise that resolves when paste is complete

Parameters:

• text (string): Text to copy

Returns:

Promise<void>

 - Promise that resolves when text is copied

Parameters:

• imageBase64 (string): Base64 encoded image to recognize text from

Returns:

Promise<TextJSON>

 - 
Hierarchical text recognition data with the following structure:
- text: Complete recognized text
- textBlocks: Array of text blocks, each containing:
  - text: Block text
  - recognizedLanguage: Detected language
  - boundingBox: {left, top, right, bottom}
  - lines: Array of text lines, each containing:
    - text: Line text
    - angle: Text angle
    - confidence: Recognition confidence
    - recognizedLanguage: Language
    - boundingBox: Line coordinates
    - elements: Array of text elements (words), each containing:
      - text: Element text
      - angle: Element angle
      - confidence: Recognition confidence
      - recognizedLanguage: Language
      - boundingBox: Element coordinates
      - symbols: Array of individual characters with:
        - text: Character
        - angle: Character angle
        - confidence: Recognition confidence
        - recognizedLanguage: Language
        - boundingBox: Character coordinates

Returns:

Promise<Node>

 - Screen content tree

Returns:

Promise<{ allScreensContent: Node[] }>

 - Array of screen content trees

Parameters:

• node (object): The node to act on
• actionInt (number): The action to perform (e.g., ACTION_CLICK)
• data (object): Additional action data (optional)
• fieldsToIgnore (string[]): Fields to ignore when comparing nodes (optional)

Returns:

Promise<{ actionPerformed: boolean }>

 - Whether the action was successful

Parameters:

• maxWidth (number): Maximum width
• maxHeight (number): Maximum height
• quality (number): Image quality (0-100)

Returns:

{ name: string, description: string, id: string, revisionId: string, revision: string, timestamp: string }

 - Current automation script information

Parameters:

• packageName (string): Package name
• clearExisting (boolean): Clear existing instances

Returns:

Promise<{appList: {[packageName: string]: string}}>

 - Map of package names to app names

Parameters:

• title (string): Notification title
• message (string): Notification message

Returns:

Promise<void>

 - Promise that resolves when notification is shown