帮助与文档

> >
다운로드

 

MobPush 所有功能接口文档都在 MobPush.framework 的 MobPush.h 上。以下具体说明:

 

1、收到应用内通知接口

 

/**

收到消息通知(数据是MPushMessage对象,可能是推送数据,也可能是自定义消息数据,非APNs通道数据)

*/

extern NSString *const MobPushDidReceiveMessageNotification;

说明:应用收到消息事,MobPush会发起一个通知,开发者只需要建立一个通知收听 MobPushDidReceiveMessageNotification 并作相应处理即可。收到的数据是一个MPushMessage对象,可能是推送数据,也可能是自定义消息数据。如果是推送数据,开发者可以通过MobPush.h中的addLocalNotification:方法,让消息以本地通知形式显示(iOS 10之前的系统应用内是不会显示通知的)。

 

2APNs(苹果公司提供的推送系统)相关接口

 

/**
 设置推送环境

 @param isProduction 是否生产环境。 如果为开发状态,设置为 NO; 如果为生产状态,应改为 YES。 Default 为 YES 生产状态。
 */
+ (void)setAPNsForProduction:(BOOL)isProduction;

说明:设置推送是否是生产环境,开发状态为 NO,生产状态为 YES ,默认为生产环境。

 // 设置推送环境
#ifdef DEBUG
    [MobPush setAPNsForProduction:NO];
#else
    [MobPush setAPNsForProduction:YES];
#endif

开发者将上诉代码写在 didFinishLaunchingWithOptions 方法里。

 

/**

设置推送配置


@param configuration 配置信息

*/

+ (void)setupNotification:(MPushNotificationConfiguration *)configuration;

说明:应用要收到推送(角标、声音、弹框提醒)需要先申请权限,这个方法就是设置推送配置、申请权限的方法。用法可参考以下的例子。

//MobPush推送设置(获得角标、声音、弹框提醒权限)

MPushNotificationConfiguration *configuration = [[MPushNotificationConfiguration alloc] init];

configuration.types = MPushAuthorizationOptionsBadge | MPushAuthorizationOptionsSound | MPushAuthorizationOptionsAlert;

[MobPush setupNotification:configuration];

 

3、添加本地推送接口

/**

添加本地推送通知


@param message 消息数据

*/

- (void)addLocalNotification:(MPushMessage *)message;

前面也提到这个接口,这个接口提供显示一个本地推送的效果。

 

4、推送设置

 

MobPush支持根据标签进行推送,所以也提供了对标签的相应操作。

 

/**

获取所有标签


@param handler 结果

*/

+ (void)getTagsWithResult:(void (^) (NSArray *tags, NSError *error))handler;


/**

添加标签


@param tags 标签组

@param handler 结果

*/

+ (void)addTags:(NSArray<NSString *> *)tags result:(void (^) (NSError *error))handler;


/**

删除标签


@param tags 需要删除的标签

@param handler 结果

*/

+ (void)deleteTags:(NSArray<NSString *> *)tags result:(void (^) (NSError *error))handler;


/**

清空所有标签


@param handler 结果

*/

+ (void)cleanAllTags:(void (^) (NSError *error))handler;

 

MobPush同样支持根据别名推送,所以也提供了对别名的相应操作。

 

/**

获取别名


@param handler 结果

*/

+ (void)getAliasWithResult:(void (^) (NSString *alias, NSError *error))handler;


/**

设置别名


@param alias 别名

@param handler 结果

*/

+ (void)setAlias:(NSString *)alias result:(void (^) (NSError *error))handler;


/**

删除别名


@param handler 结果

*/

+ (void)deleteAlias:(void (^) (NSError *error))handler;

5、设置角标

/**
 设置角标值到Mob服务器
 本地先调用setApplicationIconBadgeNumber函数来显示角标,再将该角标值同步到Mob服务器,
 @param badge 新的角标值(会覆盖服务器上保存的值)
 */
+ (void)setBadge:(NSInteger)badge;

/**
 清除角标,但不清空通知栏消息(开发者根据业务需求,自行调用)

 */
+ (void)clearBadge;

 

6、获取注册ID

 

获取注册ID接口,注册ID可与用户id绑定,实现向指定用户推送消息,此接口必须在推送设置接口之后调用。

/**
 获取注册id(可与用户id绑定,实现向指定用户推送消息)

 @param handler 结果
 */
+ (void)getRegistrationID:(void(^)(NSString *registrationID, NSError *error))handler;

7、打开和关闭远程推送

(应用内推送和本地通知不送影响,只关闭远程推送)

关闭远程推送:

+ (void)stopPush;

打开远程推送:

+ (void)restartPush;

8应用处于前台时设置推送消息的提示类型

/**
 设置应用在前台有 Badge、Sound、Alert 三种类型,默认3个选项都有,iOS 10 以后设置有效。
 如果不想前台有 Badge、Sound、Alert,设置 MPushAuthorizationOptionsNone

 @param type 类型
 */
+ (void)setAPNsShowForegroundType:(MPushAuthorizationOptions)type;

9 指定删除收到的本地推送

/**
 删除指定的本地通知(可以删除未发送或者已经发送的本地通知)

 @param identifiers 推送请求标识数组,为nil,删除所有通知
 */
+ (void)removeNotificationWithIdentifiers:(NSArray <NSString *> *)identifiers;

 

附:MobPush客户端特有错误码说明

 

注:错误码都有相应的错误描述,从错误描述基本可以看出错误是什么了。

 

/**

无效参数(格式有错)

*/

const NSInteger MPushInvalidArgument = 120001;

说明:传入的参数类型有误或数据为空,会抛出这个错误。

 

/**

没有权限

*/

const NSInteger MPushNoPermission = 1200002;

 

说明:如果尚未调用registerDeviceToken:方法,就调用其他功能接口,会抛出这个错误。

 

 

 

cuvic 다운로드 아만다 다운로드 다운로드 다운로드

相关文档