# wx.onAddToSchedule(function listener)

> 基础库 3.17.6 开始支持，低版本需做[兼容处理](1003706)。

## 功能描述

监听用户点击菜单「添加提醒」按钮时触发的事件

## 参数

### function listener

用户点击菜单「添加提醒」按钮时触发的事件的监听函数

#### 参数

##### Object res

| 属性 | 类型 | 说明 |
| ---- | ---- | ---- |
| title  | string | 提醒标题，不传则默认使用当前小游戏的昵称。 |
| query  | string | 查询字符串，必须是 key1=val1&key2=val2 的格式。从提醒进入后，可通过 wx.getLaunchOptionsSync() 或 wx.onShow() 获取启动参数中的 query。 |
| path  | string | 页面路径 |

## 示例代码

```javascript

  wx.onAddToSchedule(() => {
    return {
      title: '提醒标题',
    }
  })

```