ymx-getui
    正在准备搜索索引...

    接口 YmxGetui

    个推

    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 {
        id: string;
        version: string;
        bindAlias(data: AliasData): Promise<void>;
        getClientId(): Promise<ClientIdResult>;
        getSdkStatus(): Promise<SdkStatusResult>;
        queryTag(data: CmdBaseData): Promise<void>;
        removeListener(): Promise<void>;
        sendFeedbackMessage(data: SendFeedbackMessageData): Promise<void>;
        setListener(
            listener: (eventName: string, data: any) => void,
        ): Promise<void>;
        setSilentTime(data: SilentTimeData): Promise<void>;
        setTag(data: TagsData): Promise<void>;
        turnOffPush(): Promise<void>;
        turnOnPush(): Promise<void>;
        unBindAlias(data: UnbindAliasData): Promise<void>;
    }

    层级

    • JsApiBase
      • YmxGetui
    索引

    属性

    id version

    方法

    bindAlias getClientId getSdkStatus queryTag removeListener sendFeedbackMessage setListener setSilentTime setTag turnOffPush turnOnPush unBindAlias

    属性

    id: string

    获取插件 ID

    version: string

    获取插件版本，如 1.2.3

    方法

    • 绑定别名

      • 实际结果在 setListener 的 eventName onReceiveCommandResult 中异步返回。

      参数

      返回 Promise<void>

    • 查询用户标签

      • 实际结果在 setListener 的 eventName onReceiveCommandResult 中异步返回。

      参数

      返回 Promise<void>

    • 移除监听器

      返回 Promise<void>

    • 设置监听器，接收 eventName 事件名称，data 事件数据

      注意： 此接口为覆盖操作，仅保留最后一个监听器，最后的 listener 才能收到事件通知。

      参数

      • listener: (eventName: string, data: any) => void

      返回 Promise<void>

    • 设置一组标签，后续可使用该标签定向推送。

      • 实际结果在 setListener 的 eventName onReceiveCommandResult 中异步返回。

      参数

      返回 Promise<void>

    • 关闭 Push 推送，关闭后则无法收到推送消息，若调用了该接口关闭了推送，则只能调用 turnOnPush 才能正常推送。

      返回 Promise<void>

    • 打开 Push 推送，默认是开启状态，可以使用 turnOffPush 接口关闭推送。

      返回 Promise<void>

    • 解绑别名

      • 实际结果在 setListener 的 eventName onReceiveCommandResult 中异步返回。

      参数

      返回 Promise<void>

    显示设置

    成员可见性

    目录

    属性
    方法