宇信科技-新一代移动金融开发平台YUMP

# Push

# createMessage

创建本地消息(系统通知)

  • 参数说明

    参数名 类型 必填 说明
    data Object 是 推送消息参数
    completedCB Function 可选 请求完成回调函数，成功/失败都会触发

  • 参数data说明

    参数名 类型 必填 说明
    content String 是 消息显示的内容，在系统通知中心中显示的文本内容。
    payload String 否 消息承载的数据，可根据业务逻辑自定义json数据格式。
    options Object{MessageOptions} 是 创建消息的额外参数
    notificationId String 是 本地消息id(Android 忽略此参数，因为android支持覆盖消息需要自动生成notificationId，会在createMessage后返回消息的notificationId，执行remove方法的id就可以使用返回的notificaitionId)

  • 参数options说明

    参数名 类型 必填 说明
    delay Number 是 提示消息延迟显示的时间
    appid String 否 要启动流应用的appid，仅在流应用环境中有效，默认值为当前流应用的appid。 iOS - ALL (不支持): 不支持覆盖消息，只能创建新的消息。
    cover Boolean 否 是否覆盖上一次提示的消息 。iOS - ALL (不支持): 不支持覆盖消息，只能创建新的消息。
    icon String 否 推送消息的图标。 iOS - ALL (不支持): 不支持自定义图片，固定使用应用图标。icon设置的是通知栏的大图标，通知栏的小图标不支持。
    sound String 否 推送消息的提示音。显示消息时的播放的提示音,可取值:“system”表示使用系统通知提示音; “none”表示不使用提示音;默认值为“system”。
    title String 否 推送消息的标题。在系统消息中心显示的通知消息标题，默认值为程序的名称。
    subtitle String 否 推送消息的副标题。
    when Number 否 消息上显示的提示时间,android接收时间戳，以long的类型传递下来,默认为当前时间。iOS不支持,不支持设定消息的显示时间,由系统自动管理消息的创建时间

  • completedCB返回参数说明

    参数名 类型 说明
    status Number 调用状态码 0成功, 失败请查看全局返回码
    message String 调用结果信息
    payload Object{Result} 详细结果

  • 返回Result参数说明

    参数名 类型 说明
    result Boolean true成功，false失败
    notificationId String Android特有字段，Android会在创建本地消息后返回创建消息的id，用户需要自己维护

  • 示例代码


var data = {
    "content": "您好,本地推送内容",
    "payload": "",
    "notificationId":"100000000",
    "options" : {
        "delay": "10",
        "sound": "system",
        "title": "推送标题",
        "subtitle": "推送副标题"
    }
}
foxsdk.push.createMessage(data, ret => {
    foxsdk.logger.info('push/createMessage===status: ' + ret.status + ',message: ' + ret.message + ',payload: ' + JSON.stringify(ret.payload));
});

# getAllMessage

获取所有本地推送消息

  • 参数说明

    参数名 类型 必填 说明
    completedCB Function 可选 请求完成回调函数，成功/失败都会触发

  • completedCB返回参数说明

    参数名 类型 说明
    status Number 调用状态码 0成功, 1：失败
    message String 调用结果信息
    payload Array[Object] 详细结果,详见下表

  • 返回Object参数说明

    参数名 类型 说明
    title Number 推送消息显示的标题
    content String 推送消息显示的内容
    notificationId String 消息的id
    payload Object{MessegeBody} 推送消息承载的数据

  • 返回MessegeBody参数说明

    参数名 类型 说明
    key1 String 额外参数1
    key2 String 额外参数2
    key3 String 额外参数3

  • 示例代码


foxsdk.push.getAllMessage(ret => {
    console.log('push/getAllMessage===status: ' + ret.status + ',message: ' + ret.message + ',payload: ' + JSON.stringify(ret.payload));
});

# remove

删除本地推送消息

  • 参数说明

    参数名 类型 必填 说明
    data String 是 本地消息id
    completedCB Function 可选 请求完成回调函数，成功/失败都会触发

  • completedCB返回参数说明

    参数名 类型 说明
    status Number 调用状态码 0成功, 1：失败
    message String 调用结果信息
    payload Object 详细结果

  • 返回payload参数说明

    参数名 类型 说明
    result Boolean 删除结果

  • 示例代码

let msgId= 'noti111';//msgId是已经创建过的消息id,此处为模拟id
 foxsdk.push.remove(msgId, ret => {
    console.log('push/remove===status: ' + ret.status + ',message: ' + ret.message + ',payload: ' + JSON.stringify(ret.payload));
});

# clear

清除通知中心的消息(会清空桌面上快捷方式的角标)

  • 参数说明

    参数名 类型 必填 说明
    completedCB Function 可选 请求完成回调函数，成功/失败都会触发

  • completedCB返回参数说明

    参数名 类型 说明
    status Number 调用状态码 0成功, 1：失败
    message String 调用结果信息
    payload Object 详细结果

  • 返回payload参数说明

    参数名 类型 说明
    result Boolean 删除结果

  • 示例代码

foxsdk.push.clear(ret => {
    console.log('push/clear===status: ' + ret.status + ',message: ' + ret.message + ',payload: ' + JSON.stringify(ret.payload));
});

# getClientInfo

获取客户端推送相关的信息

  • 参数说明

    参数名 类型 必填 说明
    completedCB Function 可选 请求完成回调函数，成功/失败都会触发

  • completedCB返回参数说明

    参数名 类型 说明
    status Number 调用状态码 0成功, 1：失败
    message String 调用结果信息
    payload Object 详细结果

  • 返回payload参数说明

    参数名 类型 说明
    systemName String 系统名称,如iOS,Android
    id String 推送通道标识,如JSPush,Getui
    token String os设备令牌（iOS设备唯一标识,用于APNS服务推送中标识设备的身份),安卓不支持
    clientid String 推送平台设备唯一标识
    appid String 推送平台服务的应用标识
    appkey String 推送平台服务器的应用键值

  • 示例代码

foxsdk.push.getClientInfo(ret => {
    console.log('push/getClientInfo===status: ' + ret.status + ',message: ' + ret.message + ',payload: ' + JSON.stringify(ret.payload));
});

# setAutoNotification

设置程序是否将消息显示在系统消息中心

  • 参数说明

    参数名 类型 必填 说明
    data Object 是 否将消息显示在系统消息中心参数
    completedCB Function 可选 请求完成回调函数，成功/失败都会触发

  • 参数data说明

    参数名 类型 必填 说明
    isNotify Boolean 是 否将消息显示在系统消息中心

  • completedCB返回参数说明

    参数名 类型 说明
    status Number 调用状态码 0成功, 1：失败
    message String 调用结果信息
    payload Object 详细结果

  • 返回payload参数说明

    参数名 类型 说明
    result Boolean 操作结果

  • 示例代码


foxsdk.push.setAutoNotification(isnotify, ret => {
    console.log('push/setAutoNotification===status: ' + ret.status + ',message: ' + ret.message + ',payload: ' + JSON.stringify(ret.payload));
});

# deleteAlias

删除别名 （iOS不支持）

  • 参数说明

    参数名 类型 必填 说明
    data Object 激光否，个推是 删除别名参数
    completedCB Function 可选 请求完成回调函数，成功/失败都会触发

  • 参数data说明

    参数名 类型 必填 说明
    alias String 激光否 个推是 待删除的别名 激光推送不需要，个推必传

  • completedCB返回参数说明

    参数名 类型 说明
    status Number 调用状态码 0成功, 1：失败
    message String 调用结果信息

  • 示例代码

var data = {"alias":"1234"};
foxsdk.push.deleteAlias(data, ret => {
    console.log('push/setAutoNotification===status: ' + ret.status + ',message: ' + ret.message + ',payload: ' + JSON.stringify(ret.payload));
});

# setAlias

绑定别名，通过别名指定推送到设备 （iOS不支持）

  • 参数说明

    参数名 类型 必填 说明
    data Object 是 设置别名参数
    completedCB Function 可选 请求完成回调函数，成功/失败都会触发

  • 参数data说明

    参数名 类型 必填 说明
    alias String 激光否 个推是 设置的别名

  • completedCB返回参数说明

    参数名 类型 说明
    status Number 调用状态码 0成功, 1：失败
    message String 调用结果信息

  • 示例代码

var data = {"alias":"1234"};
foxsdk.push.setAlias(data, ret => {
    console.log('push/setAutoNotification===status: ' + ret.status + ',message: ' + ret.message + ',payload: ' + JSON.stringify(ret.payload));
});
Last Updated: 11/13/2023, 10:26:37 AM

← 分享 →