Aliyun Push Flutter Plugin #

阿里云移动推送官方Flutter插件

一、快速入门 #

1.1 创建应用 #

EMAS平台中的应用是您实际端应用的映射，您需要在EMAS控制台创建应用，与您要加载SDK的端应用进行关联。创建应用请参见快速入门。

1.2 应用配置 #

Android

厂商通道配置：移动推送全面支持接入厂商通道，请参见配置厂商通道秘钥
短信联动配置：移动推送支持与短信联动，通过补充推送短信提升触达效果，请参见短信联动配置
多包名配置：移动推送支持预先针对各渠道添加包名，实现一次推送，全渠道包消息可达。请参见配置多包名。

iOS

证书配置：iOS应用推送需配置开发环境/生产环境推送证书，详细信息请参见iOS 配置推送证书指南。

二、安装 #

在pubspec.yaml中加入dependencies

dependencies:
    aliyun_push: 0.0.2

三、配置 #

3.1 Android #

3.1.1 AndroidManifest配置

1. AppKey、AppSecret配置

在Flutter工程的android模块下的AndroidManifest.xml文件中设置AppKey、AppSecret：

<application android:name="*****">
    <!-- 请填写你自己的- appKey -->
    <meta-data android:name="com.alibaba.app.appkey" android:value="*****"/> 
    <!-- 请填写你自己的appSecret -->
    <meta-data android:name="com.alibaba.app.appsecret" android:value="****"/> 
</application>

com.alibaba.app.appkey和com.alibaba.app.appsecret为您在EMAS平台上的App对应信息。在EMAS控制台的应用管理中或在下载的配置文件中查看AppKey和AppSecret。

AppKey和AppSecret请务必写在<application>标签下，否则SDK会报找不到AppKey的错误。

2. 消息接收Receiver配置

创建消息接收Receiver，继承自com.alibaba.sdk.android.push.MessageReceiver，并在对应回调中添加业务处理逻辑，可参考以下代码：

public class MyMessageReceiver extends MessageReceiver {
    // 消息接收部分的LOG_TAG
    public static final String REC_TAG = "receiver";
    @Override
    public void onNotification(Context context, String title, String summary, Map<String, String> extraMap) {
        // TODO处理推送通知
        Log.e("MyMessageReceiver", "Receive notification, title: " + title + ", summary: " + summary + ", extraMap: " + extraMap);
    }
    @Override
    public void onMessage(Context context, CPushMessage cPushMessage) {
            Log.e("MyMessageReceiver", "onMessage, messageId: " + cPushMessage.getMessageId() + ", title: " + cPushMessage.getTitle() + ", content:" + cPushMessage.getContent());
    }
    @Override
    public void onNotificationOpened(Context context, String title, String summary, String extraMap) {
        Log.e("MyMessageReceiver", "onNotificationOpened, title: " + title + ", summary: " + summary + ", extraMap:" + extraMap);
    }
    @Override
    protected void onNotificationClickedWithNoAction(Context context, String title, String summary, String extraMap) {
        Log.e("MyMessageReceiver", "onNotificationClickedWithNoAction, title: " + title + ", summary: " + summary + ", extraMap:" + extraMap);
    }
    @Override
    protected void onNotificationReceivedInApp(Context context, String title, String summary, Map<String, String> extraMap, int openType, String openActivity, String openUrl) {
        Log.e("MyMessageReceiver", "onNotificationReceivedInApp, title: " + title + ", summary: " + summary + ", extraMap:" + extraMap + ", openType:" + openType + ", openActivity:" + openActivity + ", openUrl:" + openUrl);
    }
    @Override
    protected void onNotificationRemoved(Context context, String messageId) {
        Log.e("MyMessageReceiver", "onNotificationRemoved");
    }
}

将该receiver添加到AndroidManifest.xml文件中：

<!-- 消息接收监听器 （用户可自主扩展） -->
<receiver
    android:name=".MyMessageReceiver"
    android:exported="false"> <!-- 为保证receiver安全，建议设置不可导出，如需对其他应用开放可通过android：permission进行限制 -->
    <intent-filter>
        <action android:name="com.alibaba.push2.action.NOTIFICATION_OPENED" />
    </intent-filter>
    <intent-filter>
        <action android:name="com.alibaba.push2.action.NOTIFICATION_REMOVED" />
    </intent-filter>
    <intent-filter>
        <action android:name="com.alibaba.sdk.android.push.RECEIVE" />
    </intent-filter>
</receiver>

3. 混淆配置

如果您的项目中使用Proguard等工具做了代码混淆，请保留以下配置：

-keepclasseswithmembernames class ** {
    native <methods>;
}
-keepattributes Signature
-keep class sun.misc.Unsafe { *; }
-keep class com.taobao.** {*;}
-keep class com.alibaba.** {*;}
-keep class com.alipay.** {*;}
-keep class com.ut.** {*;}
-keep class com.ta.** {*;}
-keep class anet.**{*;}
-keep class anetwork.**{*;}
-keep class org.android.spdy.**{*;}
-keep class org.android.agoo.**{*;}
-keep class android.os.**{*;}
-keep class org.json.**{*;}
-dontwarn com.taobao.**
-dontwarn com.alibaba.**
-dontwarn com.alipay.**
-dontwarn anet.**
-dontwarn org.android.spdy.**
-dontwarn org.android.agoo.**
-dontwarn anetwork.**
-dontwarn com.ut.**
-dontwarn com.ta.**

3.1.2 辅助通道集成

在国内Android生态中，推送通道都是由终端与云端之间的长链接来维持，非常依赖于应用进程的存活状态。如今一些手机厂家会在自家ROM中做系统级别的推送通道，再由系统分发给各个App，以此提高在自家ROM上的推送送达率。

移动推送针对小米、华为、荣耀、vivo、OPPO、魅族、谷歌等设备管控较严的情况，分别接入了相应的设备厂商推送辅助通道以提高这些设备上的到达率。

辅助通道的集成可参考辅助通道集成。

3.2 iOS #

3.2.1 Objc配置

使用Xcode打开Flutter工程的iOS模块，需要做-Objc配置，即应用的TARGETS -> Build Settings -> Linking -> Other Linker Flags ，需添加上 -ObjC 这个属性，否则推送服务无法正常使用。

Other Linker Flags中设定链接器参数-ObjC，加载二进制文件时，会将 Objective-C 类和 Category 一并载入，若工程依赖多个三方库，将所有 Category 一并加载后可能发生冲突，可以使用 -force_load 单独载入指定二进制文件，配置如下：

-force_load<framework_path>/CloudPushSDK.framework/CloudPushSDK

四、APIs #

`initPush` #

Future<Map<dynamic, dynamic>> initPush({String? appKey, String? appSecret}) async

参数:

参数名	类型	是否必须
appKey	String	可选参数
appSecret	String	可选参数

Android的AppKey和AppSecret是配置在AnroidManifest.xml文件中。

返回值：

Map<dynamic, dynamic>

map中包含两个key值:

code: 错误码
errorMsg: 错误信息

代码示例:

String appKey;
String appSecret;
if (Platform.isIOS) {
 appKey = "填写自己iOS项目的appKey";
 appSecret = "填写自己iOS项目的appSecret";
} else {
 appKey = "";
 appSecret = "";
}

_aliyunPush.initPush(appKey: appKey, appSecret: appSecret)
        .then((initResult) {
var code = initResult['code'];
if (code == kAliyunPushSuccessCode) {
 print('Init Aliyun Push successfully');
 } else {
 String errorMsg = initResult['errorMsg'];
 print('Aliyun Push init failed, errorMsg is: $errorMsg);
}

`initAliyunThirdPush` #

Future<Map<dynamic, dynamic>> initAndroidThirdPush() async

**注意：**该方法只支持Android平台

初始化辅助通道

返回值：

Map<dynamic, dynamic>

map中包含两个key值:

code: 错误码
errorMsg: 错误信息

代码示例：

_aliyunPush.initAndroidThirdPush().then((initResult) {
      var code = initResult['code'];
      if (code == kAliyunPushSuccessCode) {
        print("Init Aliyun Third Push successfully");
      } else {
        print( 'Aliyun Third Push init failed, errorMsg is: $errorMsg');
      }
    });

`addMessageReceiver` #

void addMessageReceiver(
      {PushCallback? onNotification,
      PushCallback? onMessage,
      PushCallback? onNotificationOpened,
      PushCallback? onNotificationRemoved,
      PushCallback? onAndroidNotificationReceivedInApp,
      PushCallback? onAndroidNotificationClickedWithNoAction,
      PushCallback? onIOSChannelOpened,
      PushCallback? onIOSRegisterDeviceTokenSuccess,
      PushCallback? onIOSRegisterDeviceTokenFailed})

注册推送相关的回调

参数:

参数名	类型	是否必须	支持平台	功能
onNotification	PushCallback	可选参数	Android/iOS	收到通知的回调
onMessage	PushCallback	可选参数	Android/iOS	收到消息的回调
onNotificationOpened	PushCallback	可选参数	Android/iOS	从通知栏打开通知的扩展处理
onNotificationRemoved	PushCallback	可选参数	Android/iOS	通知删除回调
onAndroidNotificationReceivedInApp	PushCallback	可选参数	Android	应用处于前台时通知到达回调
onAndroidNotificationClickedWithNoAction	PushCallback	可选参数	Android	无动作通知点击回调。当在后台或阿里云控制台指定的通知动作为无逻辑跳转时, 通知点击回调为onNotificationClickedWithNoAction而不是onNotificationOpened
onIOSChannelOpened	PushCallback	可选参数	iOS	通道channel打开的回调
onIOSRegisterDeviceTokenSuccess	PushCallback	可选参数	iOS	注册APNs token成功回调
onIOSRegisterDeviceTokenFailed	PushCallback	可选参数	iOS	注册APNs token失败回调

代码示例：

_aliyunPush.addMessageReceiver(
        onNotification: _onNotification,
        onNotificationOpened: _onNotificationOpened,
        onNotificationRemoved: _onNotificationRemoved,
        onMessage: _onMessage,
        onAndroidNotificationReceivedInApp: _onAndroidNotificationReceivedInApp,
        onAndroidNotificationClickedWithNoAction:
            _onAndroidNotificationClickedWithNoAction,
        onIOSChannelOpened: _onIOSChannelOpened,
        onIOSRegisterDeviceTokenSuccess: _onIOSRegisterDeviceTokenSuccess,
        onIOSRegisterDeviceTokenFailed: _onIOSRegisterDeviceTokenFailed);

getDeviceId #

Future<String> getDeviceId()

获取设备Id

返回值：

String - 设备Id

代码示例：

_aliyunPush.getDeviceId().then((deviceId) {
});

bindAccount #

Future<Map<dynamic, dynamic>> bindAccount(String account) async

绑定账号

参数:

参数名	类型	是否必须	含义
account	String	必须参数	要绑定的账号

返回值：

Map<dynamic, dynamic>

map中包含两个key值:

code: 错误码
errorMsg: 错误信息

代码实例:

_pushPlugin.bindAccount(account).then((bindResult) {
    var code = bindResult['code'];
    if (code == kAliyunPushSuccessCode) {             
    } else {
    }
});

unbindAccount #

Future<Map<dynamic, dynamic>> unbindAccount(String account) async

解绑账号

返回值：

Map<dynamic, dynamic>

map中包含两个key值:

code: 错误码
errorMsg: 错误信息

代码实例:

_pushPlugin.unbindAccount(account).then((unbindResult) {
    var code = unbindResult['code'];
    if (code == kAliyunPushSuccessCode) {             
    } else {
    }
});

`addAlias` #

Future<Map<dynamic, dynamic>> addAlias(String alias) async

添加别名

参数:

参数名	类型	是否必须	含义
alias	String	必须参数	要添加的别名

返回值：

Map<dynamic, dynamic>

map中包含两个key值:

code: 错误码
errorMsg: 错误信息

代码示例：

_pushPlugin.addAlias(account).then((addResult) {
    var code = addResult['code'];
    if (code == kAliyunPushSuccessCode) {             
    } else {
    }
});

`removeAlias` #

Future<Map<dynamic, dynamic>> removeAlias(String alias) async

移除别名

参数:

参数名	类型	是否必须	含义
alias	String	必须参数	要移除的别名

返回值：

Map<dynamic, dynamic>

map中包含两个key值:

code: 错误码
errorMsg: 错误信息

代码示例：

_pushPlugin.removeAlias(account).then((result) {
    var code = result['code'];
    if (code == kAliyunPushSuccessCode) {             
    } else {
    }
});

`listAlias` #

Future<Map<dynamic, dynamic>> listAlias() async

查询别名

返回值：

Map<dynamic, dynamic>

map中包含三个key值:

code: 错误码
errorMsg: 错误信息
aliasList: 别名列表

代码示例：

_pushPlugin.listAlias(account).then((result) {
    var code = result['code'];
    if (code == kAliyunPushSuccessCode) {      
    var aliasList = result['aliasList'];       
    } else {
    }
});

`bindTag` #

Future<Map<dynamic, dynamic>> bindTag(List<String> tags,{int target = kAliyunTargetDevice, String? alias}) async

添加标签

参数:

参数名	类型	是否必须	含义
tags	List	必须参数	要绑定的标签列表
target	int	可选参数	目标类型，1: 本设备 2: 本设备绑定账号 3: 别名默认是1
alias	String	可选参数	别名（仅当target = 3时生效）

返回值：

Map<dynamic, dynamic>

map中包含两个key值:

code: 错误码
errorMsg: 错误信息

代码实例:

_pushPlugin.bindTag(tags).then((result) {
    var code = result['code'];
    if (code == kAliyunPushSuccessCode) {             
    } else {
    }
});

`unbindTag` #

Future<Map<dynamic, dynamic>> unbindTag(List<String> tags, {int target = kAliyunTargetDevice, String? alias}) async

移除标签

参数:

参数名	类型	是否必须	含义
tags	List<String>	必须参数	要移除的标签列表
target	int	可选参数	目标类型，1: 本设备 2: 本设备绑定账号 3: 别名默认是1
alias	String	可选参数	别名（仅当target = 3时生效）

返回值：

Map<dynamic, dynamic>

map中包含两个key值:

code: 错误码
errorMsg: 错误信息

代码实例:

_pushPlugin.unbindTag(tags).then((result) {
    var code = result['code'];
    if (code == kAliyunPushSuccessCode) {             
    } else {
    }
});

`listTags` #

Future<Map<dynamic, dynamic>> listTags

查询标签列表

返回值：

Map<dynamic, dynamic>

map中包含三个key值:

code: 错误码
errorMsg: 错误信息
tagsList: 标签列表

代码示例：

 _pushPlugin.listTags(account).then((result) {
    var code = result['code'];
    if (code == kAliyunPushSuccessCode) {      
        var tagsList = listTagsResult['tagsList'];      
    } else {
    }
});

closeAndroidPushLog #

Future<Map<dynamic, dynamic>> closeAndroidPushLog() async

关闭Android推送SDK的Log

返回值：

Map<dynamic, dynamic>

map中包含两个key值:

code: 错误码
errorMsg: 错误信息

代码示例：

_aliyunPush.closeAndroidPushLog().then((result) {
    var code = result['code'];
    if (code == kAliyunPushSuccessCode) {
    }
});

setAndroidLogLevel #

Future<Map<dynamic, dynamic>> setAndroidLogLevel(int level) async

设置Android推送SDK输出日志的级别

参数:

参数名	类型	是否必须	含义
level	int	必须参数	日志级别 0 - Error 1 - Info 2- Debug

返回值：

Map<dynamic, dynamic>

map中包含两个key值:

code: 错误码
errorMsg: 错误信息

代码示例：


_aliyunPush.setAndroidLogLevel(logLevel).then((result) {
    var code = result['code'];
    if (code == kAliyunPushSuccessCode) {
        
    } else {
        var errorCode = result['code'];
        var errorMsg = result['errorMsg'];
    }      
});

bindPhoneNumber #

Future<Map<dynamic, dynamic>> bindPhoneNumber(String phone) async

绑定手机号码

参数:

参数名	类型	是否必须	含义
phone	string	必须参数	要绑定的电话号码

返回值：

Map<dynamic, dynamic>

map中包含两个key值:

code: 错误码
errorMsg: 错误信息

代码示例:

_aliyunPush.bindPhoneNumber(phone).then((bindResult) {
    var code = bindResult['code'];
    if (code == kAliyunPushSuccessCode) {
                  
    } else {
        var errorCode = bindResult['code'];
        var errorMsg = bindResult['errorMsg'];             
    }
});

unbindPhoneNumber #

Future<Map<dynamic, dynamic>> unbindPhoneNumber() async

解绑手机号码

返回值：

Map<dynamic, dynamic>

map中包含两个key值:

code: 错误码
errorMsg: 错误信息

代码示例:

_aliyunPush.unbindPhoneNumber().then((unbindResult) {
    var code = unbindResult['code'];
    if (code == kAliyunPushSuccessCode) {
                
    } else {
        var errorCode = unbindResult['code'];
        var errorMsg = unbindResult['errorMsg'];          
    }
});

setNotificationInGroup #

Future<Map<dynamic, dynamic>> setNotificationInGroup(bool inGroup) async

设置通知分组展示

参数:

参数名	类型	是否必须	含义
inGroup	bool	必须参数	true-开启分组;false-关闭分组

返回值：

Map<dynamic, dynamic>

map中包含两个key值:

code: 错误码
errorMsg: 错误信息

代码示例：

_aliyunPush.setNotificationInGroup(true).then((result){
    var code = result['code'];
    if (code == kAliyunPushSuccessCode) {
        print('开启通知分组展示成功');
     }
});

_aliyunPush.setNotificationInGroup(false).then((result){
    var code = result['code'];
    if (code == kAliyunPushSuccessCode) {
        print('关闭通知分组展示成功');
     }
});

clearNotifications #

Future<Map<dynamic, dynamic>> clearNotifications() async

清除所有通知

返回值：

Map<dynamic, dynamic>

map中包含两个key值:

code: 错误码
errorMsg: 错误信息

代码示例:

_aliyunPush.clearNotifications().then((result) {
    var code = result['code'];
    if (code == kAliyunPushSuccessCode) {           
    }
});

createAndroidChannel #

Future<Map<dynamic, dynamic>> createAndroidChannel( String id, String name, int importance, String description, {String? groupId, bool? allowBubbles, bool? light, int? lightColor, bool? showBadge, String? soundPath, int? soundUsage, int? soundContentType, int? soundFlag, bool? vibration, List<int>? vibrationPatterns})

创建Android平台的NotificationChannel

参数:

参数名	类型	是否必须	含义
id	String	必须参数	通道id
name	String	必须参数	通道name
importance	int	必须参数	通道importance
desc	String	必须参数	通道描述
groupId	String	可选参数	-
allowBubbles	bool	可选参数	-
light	bool	可选参数	-
lightColor	int	可选参数	-
showBadge	bool	可选参数	-
soundPath	String	可选参数	-
soundUsage	int	可选参数	-
soundContentType	int	可选参数	-
soundFlag	int	可选参数	-
vibration	bool	可选参数	-
vibrationPatterns	List<int>	可选参数	-

返回值：

Map<dynamic, dynamic>

map中包含两个key值:

code: 错误码
errorMsg: 错误信息

代码示例：


_aliyunPush.createAndroidChannel(_channelController.text, '测试通道A', 3, '测试创建通知通道')
    .then((createResult) {
        var code = createResult['code'];
        if (code == kAliyunPushSuccessCode) {
            Fluttertoast.showToast(
                msg: '创建$channel通道成功', gravity: ToastGravity.CENTER);
        } else {
            var errorCode = createResult['code'];
            var errorMsg = createResult['errorMsg'];
            Fluttertoast.showToast(
                msg: '创建$channel通道失败, $errorCode - $errorMsg',
                gravity: ToastGravity.CENTER);
            }
        });

createAndroidChannelGroup #

Future<Map<dynamic, dynamic>> createAndroidChannelGroup(String id, String name, String desc) async

创建通知通道的分组

参数:

参数名	类型	是否必须	含义
id	String	必须参数	通道id
name	String	必须参数	通道name
desc	String	必须参数	通道描述

返回值：

Map<dynamic, dynamic>

map中包含两个key值:

code: 错误码
errorMsg: 错误信息

isAndroidNotificationEnabled #

Future<bool> isAndroidNotificationEnabled({String? id}) async

检查通知状态

参数:

参数名	类型	是否必须	含义
id	String	可选参数	通道id

返回值：

bool - true: 已打开; false：未打开

代码示例：

bool isEnabled = await _aliyunPush.isAndroidNotificationEnabled(
                id: 'xxx');

jumpToAndroidNotificationSettings #

void jumpToAndroidNotificationSettings({String? id})

跳转到通知设置页面

代码示例:

_aliyunPush.jumpToAndroidNotificationSettings();

turnOnIOSDebug #

Future<Map<dynamic, dynamic>> turnOnIOSDebug() async

打开iOS推送SDK的日志

返回值：

Map<dynamic, dynamic>

map中包含两个key值:

code: 错误码
errorMsg: 错误信息

代码示例：

_aliyunPush.turnOnIOSDebug().then((result) {
    var code = result['code'];
    if (code == kAliyunPushSuccessCode) {
    }
});

showIOSNoticeWhenForeground #

setIOSBadgeNum #

设置角标数

syncIOSBadgeNum #

同步角标数

getApnsDeviceToken #

Future<String> getApnsDeviceToken() async

获取APNs Token

返回值：

String - APNs Token

代码示例：

_aliyunPush.getApnsDeviceToken().then((token) {
});

isIOSChannelOpened #

Future<bool> isIOSChannelOpened() async

通知通道是否已打开

返回值：

bool - true: 已打开; false：未打开

代码示例：

_aliyunPush.isIOSChannelOpened().then((opened) {
 if (opened) {          
 } else {          
 }
});

五、错误码 #

名称	值	含义
kAliyunPushSuccessCode	"10000"	成功
kAliyunPushFailedCode	"10001"	通用失败码
kAliyunPushOnlyAndroid	"10002"	方法只支持Android平台
kAliyunPushOnlyIOS	"10003"	方法只支持iOS平台
kAliyunPushNotSupport	"10004"	平台不支持，比如Android创建group只支持Android 8.0以上版本

aliyun_push 0.0.3 aliyun_push: ^0.0.3 copied to clipboard

Metadata

Aliyun Push Flutter Plugin #

一、快速入门 #

1.1 创建应用 #

1.2 应用配置 #

二、安装 #

三、配置 #

3.1 Android #

3.1.1 AndroidManifest配置

3.1.2 辅助通道集成

3.2 iOS #

3.2.1 Objc配置

四、APIs #

initPush #

initAliyunThirdPush #

addMessageReceiver #

getDeviceId #

bindAccount #

unbindAccount #

addAlias #

removeAlias #

listAlias #

bindTag #

unbindTag #

listTags #

closeAndroidPushLog #

setAndroidLogLevel #

bindPhoneNumber #

unbindPhoneNumber #

setNotificationInGroup #

clearNotifications #

createAndroidChannel #

createAndroidChannelGroup #

isAndroidNotificationEnabled #

jumpToAndroidNotificationSettings #

turnOnIOSDebug #

showIOSNoticeWhenForeground #

setIOSBadgeNum #

syncIOSBadgeNum #

getApnsDeviceToken #

isIOSChannelOpened #

五、错误码 #

← Metadata

Publisher

Metadata

License

Dependencies

More

aliyun_push 0.0.3
aliyun_push: ^0.0.3 copied to clipboard

`initPush` #

`initAliyunThirdPush` #

`addMessageReceiver` #

`addAlias` #

`removeAlias` #

`listAlias` #

`bindTag` #

`unbindTag` #

`listTags` #