Skip to content

wechatSubscribeMessageInMiniapp

微信小程序订阅消息请求适配器,showWxSubscribeMessage 内部调用

前置依赖

typescript
interface SubscribeMessageInMiniappDeps {
  requestSubscribeMessage: UniApp['requestSubscribeMessage']
  log: Console['log']
  error: Console['error']
}
依赖说明
requestSubscribeMessage小程序订阅消息 API
log / error成功 / 失败日志

wechatSubscribeMessageInMiniapp

函数签名

typescript
function wechatSubscribeMessageInMiniapp(
  options?: SubscribeMessageOptions,
  deps: SubscribeMessageInMiniappDeps
): Promise<SubscribeMessageResult>

参数

参数名类型必填说明
options.tmplIdsstring[]是*模板 ID 列表;与 tmplId 二选一
options.tmplIdstring是*单个模板 ID,会转为单元素数组
depsSubscribeMessageInMiniappDeps环境依赖

* 至少提供一个模板 ID;单次最多 3 个。

返回值

类型说明
Promise<SubscribeMessageResult>含各模板 ID 对应的订阅状态('accept' / 'reject' 等)及 raw

工作原理

  1. tmplIdstmplId 归一化模板列表;空列表 reject。
  2. 超过 3 个模板 reject(微信单次上限)。
  3. 调用 requestSubscribeMessage({ tmplIds }),成功时将响应展开到结果对象(键为模板 ID)。
  4. 用户拒绝某模板不会导致 Promise reject,状态体现在对应 tmplId 字段值中。