基础设置接口

更新时间:2025-03-25 11:59:28

本文档介绍 iOS SDK 提供的基础 API 接口,包括初始化、调试日志管理、获取 SDK 版本号、自有通道状态检查以及推送设备 ID 获取。

设置日志等级

在应用开发阶段,为了便于问题定位和调试,建议开启 SDK 的详细日志输出。在应用上线之前,关闭此功能以确保性能和安全。

日志等级定义

typedef NS_ENUM(NSInteger, MPLogLevel) {
    MPLogLevelNone = 0,
    MPLogLevelError = 1,
    MPLogLevelWarn = 2,
    MPLogLevelInfo = 3,
    MPLogLevelDebug = 4
};

接口定义

+ (void)setLogLevel:(MPLogLevel)level;

代码示例

Swift
Object C
CloudPushSDK.setLogLevel(MPLogLevel.info);
[CloudPushSDK setLogLevel:MPLogLevelInfo];

初始化SDK

使用appKeyappSecret初始化 SDK,初始化后可通过回调函数确认结果。

接口定义

+ (void)startWithAppkey:(NSString *)appKey
              appSecret:(NSString *)appSecret
               callback:(CallbackHandler)callback;

参数说明

参数

类型

是否必填

说明

参数

类型

是否必填

说明

appKey

NSString

移动推送服务的 appKey

appSecret

NSString

移动推送服务的 appSecret

callback

Block

初始化状态的回调函数

代码示例

Swift
Object C
CloudPushSDK.start(withAppkey: "您的AppKey", appSecret: "您的AppSecret") { res in
    if res.success {
        print("SDK初始化成功 | DeviceID: \(CloudPushSDK.getDeviceId() ?? "N/A")")
    } else {
        print("初始化失败: \(result.error?.localizedDescription ?? "未知错误")")
    }
}
[CloudPushSDK startWithAppkey:@"您的AppKey" 
                    appSecret:@"您的AppSecret" 
                    callback:^(CloudPushCallbackResult *result) {
    if (result.success) {
        NSLog(@"SDK初始化成功 | DeviceID: %@", [CloudPushSDK getDeviceId]);
    } else {
        NSLog(@"初始化失败: %@", result.error);
    }
}];

获取SDK版本号

可以通过以下 API 获取当前 SDK 的版本号,或者使用宏定义MPUSH_IOS_SDK_VERSION

接口定义

+ (NSString *)getVersion;

查询消息通道状态

检查当前应用内的推送通道是否已经打开。

接口定义

+ (BOOL)isChannelOpened;

设备ID

在 SDK 初始化成功后,可以通过以下接口获取设备 ID。该 ID 在同一 App 下是唯一的标识,但在某些情况下(如 iOS 系统升级或设备重置)可能会发生变化。

接口定义

+ (NSString *)getDeviceId;

(废弃)打开调试日志

在应用开发阶段,为了便于问题定位和调试,建议开启 SDK 的详细日志输出。在应用上线之前,关闭此功能以确保性能和安全。

接口定义

+ (void)turnOnDebug;

(废弃)SDK自动初始化

无需配置appKeyappSecret,结合AliyunEmasServices-Info.plist配置文件使用。

接口定义

+ (void)autoInit:(CallbackHandler)callback;

参数说明

参数

类型

是否必填

说明

参数

类型

是否必填

说明

callback

Block

初始化状态的回调函数

(废弃)SDK手动初始化

输入appKeyappSecret初始化推送SDK。

接口定义

+ (void)asyncInit:(NSString *)appKey
        appSecret:(NSString *)appSecret
         callback:(CallbackHandler)callback;

参数说明

参数

类型

是否必填

说明

参数

类型

是否必填

说明

appKey

NSString

移动推送服务的 appKey

appSecret

NSString

移动推送服务的 appSecret

callback

Block

初始化状态的回调函数

(废弃)关闭推送消息通道

关闭推送消息通道(长链),需要保证在SDK初始化之前调用。

接口定义

+ (void)closeCCPChannel;

  • 本页导读 (0)
  • 设置日志等级
  • 日志等级定义
  • 接口定义
  • 代码示例
  • 初始化SDK
  • 接口定义
  • 参数说明
  • 代码示例
  • 获取SDK版本号
  • 接口定义
  • 查询消息通道状态
  • 接口定义
  • 设备ID
  • 接口定义
  • (废弃)打开调试日志
  • 接口定义
  • (废弃)SDK自动初始化
  • 接口定义
  • 参数说明
  • (废弃)SDK手动初始化
  • 接口定义
  • 参数说明
  • (废弃)关闭推送消息通道
  • 接口定义
AI助理

点击开启售前

在线咨询服务

你好,我是AI助理

可以解答问题、推荐解决方案等