跳到主要内容

增加或清空本地推送(AddLocalNotification/ClearLocalNotifications)

AndroidiOS
如果您使用的是 Unreal Engine,请参见 Unreal Engine SDK 的 AddLocalNotification
警告

Android 平台需启用 INTLConfig.ini 里的 ANDROID_LOCAL_NOTIFICATION_ENABLE 配置。

本地通知由用户自定义设置,保存在本地,根据时间触发。

当设置的时间小于当前设备时间,通知立即弹出。

说明

Android 和 iOS 的消息结构体不一样。

函数定义

// 增加本地推送
public static void AddLocalNotification(string channel, INTLLocalNotification localNotification);

// 清空本地推送
public static void ClearLocalNotifications(string channel);

入参说明

参数类型说明
channelstring渠道定义
例如 "Firebase"
localNotificationINTLLocalNotification本地消息结构体

回调处理

回调处理接口是 PushResultObserver。回调数据结构是 PushResult

回调 ID 是 INTL_PUSH_ADD_LOCAL_NOTIFICATIONINTL_PUSH_CLEAR_LOCAL_NOTIFICATIONS.。

代码示例

#if UNITY_IOS
INTLLocalNotification message = new INTLLocalNotification ();
TimeSpan ts = DateTime.UtcNow - new DateTime(1970, 1, 1, 0, 0, 0, 0);
message.FireTime = Convert.Toint(ts.TotalSeconds) + 5;
message.AlertBody = "INTL Push iOS test";
message.AlertAction = "INTL Action";
message.Badge = 2;
message.RepeatType = 1;
Dictionary<string,string> userInfo1 = new Dictionary<string,string>();
userInfo1["key1"] = "value1";
Dictionary<string,string> userInfo2 = new Dictionary<string,string>();
userInfo2["key2"] = "value2";
message.UserInfo = new List<Dictionary<string,string>>();
message.UserInfo.Add(userInfo1);
message.UserInfo.Add(userInfo2);
INTLAPI.AddLocalNotification (INTLChannel.Firebase, message);
//INTLAPI.ClearLocalNotifications(INTLChannel.Firebase);
#endif
#if UNITY_ANDROID
INTLLocalNotification message = new INTLLocalNotification();
message.NotificationID = 0;//
message.ActionType = 1;
message.SoundEnabled = 1;
message.Lights = 1;
message.Vibrate = 1;
TimeSpan ts = DateTime.UtcNow - new DateTime(1970, 1, 1, 0, 0, 0, 0);
message.FireTime = Convert.Toint(ts.TotalSeconds) + 5;
message.Title = "INTL Push Android title";
message.Content = "INTL Push Android content";
message.TickerText = "INTL Push Android ticker text";
message.ActionParameter = "com.intlgame.demo.xxxActivity";
message.RingUri = "android.resource://intlgame.demo/raw/ring_file";
message.SmallIcon = "drawable_name";
INTLAPI.AddLocalNotification (INTLChannel.xxx, message);
//INTLAPI.ClearLocalNotifications(INTLChannel.xxx);
#endif

数据结构

Android

INTLLocalNotification

成员变量名称类型说明
ActionTypeint设置动作类型:
1:打开 activity 或 app 本身
2:打开浏览器
3:打开 Intent
4:通过包名打开应用
NotificationIDint指定通知 ID;已展示的相同 ID 的通知,被后触发的通知覆盖
Titlestring设置消息标题
Contentstring设置消息内容
TickerTextstring设置标题栏走马灯内容
ActionParameterstring当 ActionType=1 时,ActionParameter 可以为应用内的 Activity 的类名。例如 com.intl.TestActivity。
当 ActionType=2 时,ActionParameter 是一个 URL,点击通知后,直接用浏览器打开此URL地址。
当 ActionType=3 时,ActionParameter 是一个序列化的 Intent。
当 ActionType=4 时,ActionParameter 为应用包名。
FireTimelong设置通知触发时间,long 类型(UTC时间的时间戳,单位:秒)
SoundEnabledint是否播放声音
0:否
1:是
默认:1
RingUristring指定应用内的声音(raw/ring.mp3),例如:android.resource://intlgame.demo/raw/ring
SmallIconstring指定状态栏的小图片(test.png)
例如:test
Lightsint是否呼吸灯
0:否
1:是
默认:0
Vibrateint是否振动
0:否
1:是
默认:0

iOS

INTLLocalNotification

成员变量类型说明
NotificationIDstring[Required]
指定通知 ID
已展示的相同 ID,通知会被后触发的通知覆盖。
RepeatTypeint推送重复发送周期
1:分钟
2:小时
3:天
4:星期
5:月
6:年
默认:0,代表不重复
FireTimelong本地推送触发的时间
Badgeint角标
AlertBodystring推送的内容
AlertActionstring替换弹框的按钮文字内容
默认为:启动
UserInfoList<Dictionary<string,string>>自定义参数,可以用来标识推送和增加附加信息
AlertTitlestring推送的简短描述