订阅消息

接口定义

qg.requestSubscribeMessage(Object object)

• 描述

  调起快游戏订阅消息界面，返回用户订阅消息的操作结果。

• 参数object
  展开

  参数	类型	必填(M)/选填(O)	说明
  tmplIds	Array<string>	M	需要订阅的消息模板的ID的集合，一次调用最多可订阅3条消息。
  success	function	O	接口调用成功的回调函数，详情请参见success回调函数参数。
  fail	function	O	接口调用失败的回调函数，详情请参见fail回调函数参数。
  complete	function	O	若有函数传入，将在成功、失败后调用该函数。

  • success回调函数参数
    展开

    参数名	类型	说明
    errMsg	string	接口调用成功时，errMsg的值为“requestSubscribeMessage:ok”。
    [TEMPLATE_ID:string]	string	[TEMPLATE_ID]是动态的键，即订阅模板ID，取值说明如下： accept：表示用户同意订阅该条ID对应的订阅模板消息。 reject：表示用户拒绝订阅该条ID对应的订阅模板消息。 ban：表示已被后台封禁。 filter：表示该订阅模板因为模板标题同名被后台过滤。 例如{errMsg: "requestSubscribeMessage:ok", 123456789: "accept"}表示用户同意订阅模板ID为123456789的这条消息。

  • fail回调函数参数
    展开

    参数名称	说明
    errCode	错误码。
    errMsg	错误信息。

• 示例代码
  收起

  自动换行

  深色代码主题

  复制

  if (typeof qg.canIUse === 'function') {
      const isSupportSubscribePushMsg = qg.canIUse('MiniGame.SubscribePushMsg');
      if (isSupportSubscribePushMsg) {
          qg.requestSubscribeMessage({
              tmplIds: ['123456789','123456790'],
              success : function (res) {
                  console.log("requestSubscribeMessage success： " + JSON.stringify(res));
              },
              fail:function(errMsg, errCode){
                  console.log("requestSubscribeMessage fail: "+ errMsg + ", errCode: " + errCode);
              },
              complete:function() {
                  console.log("requestSubscribeMessage complete");
              }
          });
      }
  }

qg.querySubscribeSetting()

• 描述

  查询订阅设置开关。

• 参数
  展开

  参数	类型	必填(M)/选填(O)	说明
  success	function	O	接口调用成功的回调函数，详情请参见success回调函数参数。
  fail	function	O	接口调用失败的回调函数，详情请参见fail回调函数参数。
  complete	function	O	若有函数传入，将在成功、失败后调用该函数。

  • success回调函数参数
    展开

    参数名	类型	说明
    enable	boolean	通知总开关。
    templateSettings	Array<TemplateSetting>	订阅模板设置。详情请参见TemplateSetting参数。

    • TemplateSetting参数
      展开

      参数	类型	说明
      tmplId	string	订阅模板ID。
      tmplName	string	订阅模板名称。
      enable	boolean	订阅模板开关。
      type	integer	订阅模板类型： 0：一次性订阅。 1：长期订阅。

  • fail回调函数参数
    展开

    参数名称	说明
    errCode	错误码。
    errMsg	错误信息。

• 示例代码
  收起

  自动换行

  深色代码主题

  复制

  if (typeof qg.canIUse === 'function') {
      const isSupportSubscribePushMsg = qg.canIUse('MiniGame.SubscribePushMsg');
      if (isSupportSubscribePushMsg) {
          qg.querySubscribeSetting({
              success: function (ret) {
                  console.log('querySubscribeSetting success: ' + JSON.stringify(ret));
              },
              fail: function (errMsg, errCode) {
                  console.log('querySubscribeSetting fail: ' + errMsg + ", errCode: " + errCode);
              },
              complete:function() {
                  console.log("querySubscribeSetting complete");
              }
          });
      }
  }

错误码