@ymxjs/ymx-getui 1.0.0

package/package.json

@@ -0,0 +1,20 @@
+{
+  "name": "@ymxjs/ymx-getui",
+  "version": "1.0.0",
+  "description": "TypeScript definitions for ymx plugin ymx-getui",
+  "types": "types.d.ts",
+  "keywords": [
+    "ymx",
+    "ymxjs",
+    "ymx-getui"
+  ],
+  "homepage": "https://zsite.cc/market/ymx-getui",
+  "author": "ymx",
+  "license": "MIT",
+  "dependencies": {
+    "@ymxjs/core": "^1.260819.0"
+  },
+  "files": [
+    "types.d.ts"
+  ]
+}

package/readme.md

@@ -0,0 +1,25 @@
+ymxjs 插件接口申明
+=======
+
+[ymx-getui](https://zsite.cc/market/ymx-getui)  
+个推消息推送
+
+- 安装
+```bash
+npm install --save-dev @ymxjs/ymx-getui
+```
+
+- 配置 `tsconfig.json`
+```json
+{
+  "compilerOptions": {
+    "types": ["@ymxjs/ymx-getui"]
+  }
+}
+```
+
+- 使用
+```ts
+const plugin = ymx.requirePlugin('ymx-getui') as YmxGetui;
+//...
+```

package/types.d.ts

@@ -0,0 +1,118 @@
+
+declare namespace YmxGetui {
+
+  interface ClientIdResult {
+    /** 客户端 Id (cid)，如果个推初始化失败则返回空。*/
+    clientId?: string;
+  }
+
+  interface SdkStatusResult extends ClientIdResult {
+    /** 个推 SDK 版本号 */
+    sdkVersion: string;
+    /**
+     * 是否初始化成功
+     * - `true` 成功
+     * - `false` 失败
+     * - `undefined` 未初始化
+     * */
+    initializeSuccess?: boolean;
+    /** 初始化失败时的错误描述 */
+    initializeError?: string;
+    /** 厂商推送设备 token 标识 */
+    deviceToken?: string;
+  }
+
+  interface CmdBaseData {
+    /** 自定义的业务号，在 `setListener` 中原样返回，如果留空则系统自动生成一个随机 UUID。 */
+    sn?: string;
+  }
+
+  interface AliasData extends CmdBaseData {
+    /** 别名，长度 40 字节，支持中、英文（区分大小写）、数字以及下划线。 */
+    alias: string;
+  }
+
+  interface UnbindAliasData extends AliasData {
+    /** 别名，长度 40 字节，支持中、英文（区分大小写）、数字以及下划线。 */
+    alias: string;
+    /** 是否只对当前cid有效，如果是true，只对当前cid做解绑；如果是false，对所有绑定该别名的cid列表做解绑。*/
+    isSelf?: boolean;
+  }
+
+  interface TagsData extends CmdBaseData {
+    /** 标签数组，数组长度最大200。*/
+    tags: string[];
+  }
+
+  interface SendFeedbackMessageData {
+    /** 下发任务的任务 ID */
+    taskId: string;
+    /** 下发任务的消息 ID */
+    messageId: string;
+    /** 自定义的 actionId，取值范围是 90001-90999 */
+    actionId: number;
+  }
+
+  interface SilentTimeData {
+    /** 开始时间，beginHour >= 0 && beginHour < 24 */
+    beginHour: number;
+    /** 持续时间，duration > 0 && duration <= 23，持续时间为 0 则取消静默。 */
+    duration: number;
+  }
+}
+
+/**
+ * [个推](https://www.getui.com/)
+ *
+ * - 点击通知激活或拉起应用的启动参数见 [ymx.getLaunchParams()](https://zsite.cc/docs/api/app)，服务器端推送的所有数据都能在此接口的返回参数里面找到。
+ * - 相关 [通知 API](https://zsite.cc/docs/api/notification)
+ * - [个推鸿蒙厂商应用开通指南](https://docs.getui.com/getui/mobile/harmonyos/harmonyosstudio/)
+ * - [个推鸿蒙 API 详解](https://docs.getui.com/getui/mobile/harmonyos/api/)
+ *
+ * @example
+* ``` ts
+ * const getui = ymx.requirePlugin('ymx-getui') as YmxGetui;
+ * await getui.setListener((eventName, data) => console.log(eventName, data));
+ * await getui.getSdkStatus();
+ * //请在适当的稍候请求通知权限
+ * await ymx.requestEnableNotification()
+ * ```
+ */
+interface YmxGetui extends JsApiBase {
+
+  /**
+   * 获取个推 SDK 状态
+   * */
+  getSdkStatus(): Promise<YmxGetui.SdkStatusResult>;
+
+  /** 获取设备的客户端 Id (cid) */
+  getClientId(): Promise<YmxGetui.ClientIdResult>;
+
+  /** 打开 Push 推送，默认是开启状态，可以使用 turnOffPush 接口关闭推送。 */
+  turnOnPush(): Promise<void>;
+
+  /** 关闭 Push 推送，关闭后则无法收到推送消息，若调用了该接口关闭了推送，则只能调用 turnOnPush 才能正常推送。 */
+  turnOffPush(): Promise<void>;
+
+  /** 绑定别名
+   * - 实际结果在 `setListener` 的 eventName `onReceiveCommandResult` 中异步返回。 */
+  bindAlias(data: YmxGetui.AliasData): Promise<void>;
+
+  /** 解绑别名
+   * - 实际结果在 `setListener` 的 eventName `onReceiveCommandResult` 中异步返回。 */
+  unBindAlias(data: YmxGetui.UnbindAliasData): Promise<void>;
+
+  /** 设置一组标签，后续可使用该标签定向推送。
+   * - 实际结果在 `setListener` 的 eventName `onReceiveCommandResult` 中异步返回。 */
+  setTag(data: YmxGetui.TagsData): Promise<void>;
+
+  /** 查询用户标签
+   * - 实际结果在 `setListener` 的 eventName `onReceiveCommandResult` 中异步返回。*/
+  queryTag(data: YmxGetui.CmdBaseData): Promise<void>;
+
+  /** 自定义 actionId */
+  sendFeedbackMessage(data: YmxGetui.SendFeedbackMessageData): Promise<void>;
+
+  /** 设置静默时间 */
+  setSilentTime(data: YmxGetui.SilentTimeData): Promise<void>;
+}