system.share.d.ts

/// <reference path="./types.d.ts"/>

/**
 * 分享 share
 * @后台运行限制 禁止使用。后台运行详细用法参见后台运行 脚本。
 * @see https://doc.quickapp.cn/features/system/share.html
 */
declare module '@system.share' {
  interface Share {
    /**
     * 分享数据到其他 app
     * @example
     * ```js
     * share.share({
     *   type: 'text/html',
     *   data: '<b>bold</b>',
     *   success: function(data) {
     *     console.log('handling success')
     *   },
     *   fail: function(data, code) {
     *     console.log(`handling fail, code = ${code}`)
     *   }
     * })
     * ```
     */
    share(OBJECT: ShareOBJECT): any;
  }

  /**
   *
   * @param type 数据的 MIME TYPE，要求字母全小写
   * @param data 分享的数据：1. 如果 type 是 text/开头的 mimetype（如 text/plain），则 data 是要分享的文本内容；2. 如果 type 是其他值，则 data 是要分享的文件路径。支持三种文件路径：1. 通过 fetch.fetch 下载的文件路径；2. 通过 file.save 或 list 获得的文件路径；3. 以/开头的应用内部的资源文件。
   * @param success 成功回调。因为大部分 android app 都没有正确的返回分享状态，所以即使分享成功了，也可能执行 cancel 回调，而不是 success 回调。[可选]
   * @param fail 失败回调[可选]
   * @param cancel 取消回调[可选]
   * @param complete 执行结束后的回调[可选]
   */
  interface ShareOBJECT {
    type: String;
    data: String;
    success?: Function;
    fail?: Function;
    cancel?: Function;
    complete?: Function;
  }

  /**
   * 分享 share
   * @后台运行限制 禁止使用。后台运行详细用法参见后台运行 脚本。
   * @see https://doc.quickapp.cn/features/system/share.html
   */
  const share: Share;
  export default share;
}