app.d.ts 5.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163
  1. /**
  2. * app模块提供一系列函数,用于使用其他应用、与其他应用交互。例如发送意图、打开文件、发送邮件等。
  3. */
  4. declare namespace app {
  5. /**
  6. * 通过应用名称启动应用。如果该名称对应的应用不存在,则返回false; 否则返回true。如果该名称对应多个应用,则只启动其中某一个。
  7. */
  8. function launchApp(appName: string): boolean;
  9. /**
  10. * 通过应用包名启动应用。如果该包名对应的应用不存在,则返回false;否则返回true。
  11. */
  12. function launch(packageName: string): boolean;
  13. /**
  14. * 通过应用包名启动应用。如果该包名对应的应用不存在,则返回false;否则返回true。
  15. */
  16. function launchPackage(packageName: string): boolean;
  17. /**
  18. * 获取应用名称对应的已安装的应用的包名。如果该找不到该应用,返回null;如果该名称对应多个应用,则只返回其中某一个的包名。
  19. */
  20. function getPackageName(appName: string): string;
  21. /**
  22. * 获取应用包名对应的已安装的应用的名称。如果该找不到该应用,返回null。
  23. */
  24. function getAppName(packageName: string): string;
  25. /**
  26. * 打开应用的详情页(设置页)。如果找不到该应用,返回false; 否则返回true。
  27. */
  28. function openAppSetting(packageName: string): boolean;
  29. /**
  30. * 用其他应用查看文件。文件不存在的情况由查看文件的应用处理。如果找不出可以查看该文件的应用,则抛出ActivityNotException。
  31. *
  32. * @throws ActivityNotException
  33. */
  34. function viewFile(path: string): void;
  35. /**
  36. * 用其他应用编辑文件。文件不存在的情况由编辑文件的应用处理。如果找不出可以编辑该文件的应用,则抛出ActivityNotException。
  37. *
  38. * @throws ActivityNotException
  39. */
  40. function editFile(path: string): void;
  41. /**
  42. * 卸载应用。执行后会会弹出卸载应用的提示框。如果该包名的应用未安装,由应用卸载程序处理,可能弹出"未找到应用"的提示。
  43. */
  44. function uninstall(packageName: string): void;
  45. /**
  46. * 用浏览器打开网站url。网站的Url,如果不以"http:// "或"https:// "开头则默认是"http:// "。
  47. */
  48. function openUrl(url: string): void;
  49. /**
  50. * 发送邮件的参数,这些选项均是可选的。
  51. */
  52. interface SendEmailOptions {
  53. /**
  54. * 收件人的邮件地址。如果有多个收件人,则用字符串数组表示
  55. */
  56. email?: string | string[];
  57. /**
  58. * 抄送收件人的邮件地址。如果有多个抄送收件人,则用字符串数组表示
  59. */
  60. cc?: string | string[];
  61. /**
  62. * 密送收件人的邮件地址。如果有多个密送收件人,则用字符串数组表示
  63. */
  64. bcc?: string | string[];
  65. /**
  66. * 邮件主题(标题)
  67. */
  68. subject?: string;
  69. /**
  70. * 邮件正文
  71. */
  72. text?: string;
  73. /**
  74. * 附件的路径。
  75. */
  76. attachment?: string;
  77. }
  78. /**
  79. * 根据选项options调用邮箱应用发送邮件。如果没有安装邮箱应用,则抛出ActivityNotException。
  80. */
  81. function sendEmail(options: SendEmailOptions): void;
  82. /**
  83. * 启动Auto.js的特定界面。该函数在Auto.js内运行则会打开Auto.js内的界面,在打包应用中运行则会打开打包应用的相应界面。
  84. */
  85. function startActivity(name: 'console' | 'settings'): void;
  86. /**
  87. * Intent(意图) 是一个消息传递对象,您可以使用它从其他应用组件请求操作。尽管 Intent 可以通过多种方式促进组件之间的通信.
  88. */
  89. interface Intent { }
  90. /**
  91. * 构造意图Intent对象所需设置。
  92. */
  93. interface IntentOptions {
  94. action?: string;
  95. type?: string;
  96. data?: string;
  97. category?: string[];
  98. packageName?: string;
  99. className?: string;
  100. extras?: Object;
  101. }
  102. /**
  103. * 根据选项,构造一个意图Intent对象。
  104. */
  105. function intent(options: IntentOptions): Intent;
  106. /**
  107. * 根据选项构造一个Intent,并启动该Activity。
  108. */
  109. function startActivity(intent: Intent): void;
  110. /**
  111. * 根据选项构造一个Intent,并发送该广播。
  112. */
  113. function sendBroadcast(intent: Intent): void;
  114. }
  115. /**
  116. * 通过应用名称启动应用。如果该名称对应的应用不存在,则返回false; 否则返回true。如果该名称对应多个应用,则只启动其中某一个。
  117. */
  118. declare function launchApp(appName: string): boolean;
  119. /**
  120. * 通过应用包名启动应用。如果该包名对应的应用不存在,则返回false;否则返回true。
  121. */
  122. declare function launch(packageName: string): boolean;
  123. /**
  124. * 获取应用名称对应的已安装的应用的包名。如果该找不到该应用,返回null;如果该名称对应多个应用,则只返回其中某一个的包名。
  125. */
  126. declare function getPackageName(appName: string): string;
  127. /**
  128. * 获取应用名称对应的已安装的应用的包名。如果该找不到该应用,返回null;如果该名称对应多个应用,则只返回其中某一个的包名。
  129. */
  130. declare function getPackageName(appName: string): string;
  131. /**
  132. * 获取应用包名对应的已安装的应用的名称。如果该找不到该应用,返回null。
  133. */
  134. declare function getAppName(packageName: string): string;
  135. /**
  136. * 打开应用的详情页(设置页)。如果找不到该应用,返回false; 否则返回true。
  137. */
  138. declare function openAppSetting(packageName: string): boolean;