appium-uiautomator2-driver/lib/commands/clipboard.js

UiAutomator2 integration for Appium

/**
 * @this {AndroidUiautomator2Driver}
 * @returns {Promise<string>} Base64-encoded content of the clipboard
 * or an empty string if the clipboard is empty.
 */
export async function getClipboard() {
  return String(
    (await this.adb.getApiLevel()) < 29
      ? await this.uiautomator2.jwproxy.command(
          '/appium/device/get_clipboard',
          'POST',
          {}
        )
      : await this.settingsApp.getClipboard()
  );
}

/**
 * @this {AndroidUiautomator2Driver}
 * @param {string} content Base64-encoded clipboard payload
 * @param {'plaintext'} [contentType='plaintext'] Only a single
 * content type is supported, which is 'plaintext'
 * @param {string} [label] Optinal label to identify the current
 * clipboard payload
 * @returns {Promise<void>}
 */
export async function setClipboard(content, contentType, label) {
  await this.uiautomator2.jwproxy.command(
    '/appium/device/set_clipboard',
    'POST',
    {content, contentType, label}
  );
}

/**
 * @typedef {import('../driver').AndroidUiautomator2Driver} AndroidUiautomator2Driver
 */