Donky Modular SDK（V2.8.6.4）
Donky iOS SDK 是用于向您的应用程序添加推送通知和富内容服务的工具包。有关详细文档、教程和指南，请访问我们的在线文档。
##要求
Donky Modular SDK 的最低技术要求如下
- Xcode 6.0+
- iOS 8.0+
- 必须启用 Arc。
- 当通过 CocoaPods 集成时，库应包含为 Cocoa Touch Framework
通过 CocoaPods 导入
如果使用 Cocoapods，请在您的 Podfile 中包含 use_frameworks!。由于库的构建方式，当 SDK 作为静态库使用时，无法导入其内部使用的某些资源。框架是将外部库包含到项目中的现代方式，也是支持 Swift 的要求，因此请使用这种方式来集成 Donky SDK。
请在此处阅读我们的完整文档这里
作者
Donky Networks Ltd，[email protected]
许可证
DonkySDK-iOS-Modular遵循MIT许可证。有关更多信息，请参阅LICENSE文件。
##安装
请使用以下方法之一进行安装：
克隆Git仓库
git clone [email protected]:Donky-Network/DonkySDK-iOS-Modular.git
Please see below for all the information specific to the CocoaPods
##支持
如果您在使用或集成此SDK时遇到任何问题，请联系[email protected]。
##贡献
我们接受pull请求！
##CocoaPods
Donky-Core-SDK
使用方法
只有当您只使用SDK的此部分时，才需要在'PodFile'中添加此部分。如果使用任何附加的可选模块，则不需要将此添加到您的“Podfile”中。
匿名初始化
- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
//Start analytics (optional)
[[DCAAnalyticsController sharedInstance] start];
//Initialise Donky with API key.
[[DNDonkyCore sharedInstance] initialiseWithAPIKey:@"API-KEY"];
return YES;
}使用已知用户初始化
- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
//Start analytics (optional)
[[DCAAnalyticsController sharedInstance] start];
//Create a new user and populate with details. Country code is optional is NO mobile number is provided. If a
//mobile number is provided then a country code is mandatory. Failing to provide a country code that matches the
//mobile number will result in a server validation error.
DNUserDetails *userDetails = [[DNUserDetails alloc] initWithUserID:@""
displayName:@""
emailAddress:@""
mobileNumber:@""
countryCode:@""
firstName:@""
lastName:@""
avatarID:@""
selectedTags:@[]
additionalProperties:@{}];
//Initialise Donky with API key.
[[DNDonkyCore sharedInstance] initialiseWithAPIKey:@"API-KEY" userDetails:userDetails success:^(NSURLSessionDataTask *task, id responseData) {
NSLog(@"Successfully Initialised with user...");
} failure:^(NSURLSessionDataTask *task, NSError *error) {
NSLog(@"%@", [error localizedDescription]);
}];
return YES
}您还必须调用应用程序代理的以下方法，以确保及时接收和处理自定义内容通知
以确保您的设备令牌被发送到Donky网络
- (void)application:(UIApplication *)application didRegisterForRemoteNotificationsWithDeviceToken:(NSData *)deviceToken {
[DNNotificationController registerDeviceToken:deviceToken];
}为了处理传入的通知，使用此方法可以让您的应用程序处理内容通知
- (void)application:(UIApplication *)application didReceiveRemoteNotification:(NSDictionary *)userInfo fetchCompletionHandler:(void (^)(UIBackgroundFetchResult result))completionHandler {
[DNNotificationController didReceiveNotification:userInfo handleActionIdentifier:nil completionHandler:^(NSString *string) {
completionHandler(UIBackgroundFetchResultNewData);
}];
}为了处理交互式通知（仅限iOS 8+）
- (void)application:(UIApplication *)application handleActionWithIdentifier:(NSString *)identifier forRemoteNotification:(NSDictionary *)userInfo completionHandler:(void (^)())completionHandler {
[DNNotificationController didReceiveNotification:userInfo handleActionIdentifier:identifier completionHandler:^(NSString *string) {
completionHandler();
}];
}##示例
示例项目可以在以下位置找到
�
����src
����workspaces
����Donky Core SDK Demo
需求
- iOS 7.0+
- 必须启用 Arc。
#第三方依赖
安装
Donky-Core-SDK 可通过 CocoaPods 获取。要安装它，只需将以下行添加到您的 Podfile 中。
pod "Donky-Core-SDK"Donky-Push
使用方法
使用简单推送模块以使您的应用程序能够接收简单推送消息。
- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
//Start analytics (optional)
[[DCAAnalyticsController sharedInstance] start];
//Start push logic:
[[DPPushNotificationController sharedInstance] start];
//Initialise Donky
[[DNDonkyCore sharedInstance] initialiseWithAPIKey:@"API-KEY"];
return YES;
}您还必须调用您的应用程序代理的以下方法
以确保您的设备令牌被发送到Donky网络
- (void)application:(UIApplication *)application didRegisterForRemoteNotificationsWithDeviceToken:(NSData *)deviceToken {
[DNNotificationController registerDeviceToken:deviceToken];
}为了处理传入的通知，使用此方法可以让您的应用程序处理内容通知
- (void)application:(UIApplication *)application didReceiveRemoteNotification:(NSDictionary *)userInfo fetchCompletionHandler:(void (^)(UIBackgroundFetchResult result))completionHandler {
[DNNotificationController didReceiveNotification:userInfo handleActionIdentifier:nil completionHandler:^(NSString *string) {
completionHandler(UIBackgroundFetchResultNewData);
}];
}为了处理交互式通知（仅限iOS 8+）
- (void)application:(UIApplication *)application handleActionWithIdentifier:(NSString *)identifier forRemoteNotification:(NSDictionary *)userInfo completionHandler:(void (^)())completionHandler {
[DNNotificationController didReceiveNotification:userInfo handleActionIdentifier:identifier completionHandler:^(NSString *string) {
completionHandler();
}];
}##示例
示例项目可以在以下位置找到
�
����src
����workspaces
����Donky Simple Push Logic Demo
需求
- iOS 8.0+
- 必须启用 Arc。
- 对于交互式通知，iOS 8.0+ 是必需的。
安装
pod "Donky-Push"Pod 依赖
在 podfile 中包含以下内容将自动导入以下其他模块，因为它们是硬依赖，无需手动包含以下任何一项。
- Donky 核心SDK
- Donky 常用消息逻辑
Donky-RichMessage-Logic
使用说明
使用富消息模块可以接收来自网络的富消息并将其保存到 Donky 的本地数据库中，然后可以通过 objective-c DRLogicMainController 提供的 API 检索和删除消息。
- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
// Override point for customization after application launch.
//Start analytics controller (optional)
[[DCAAnalyticsController sharedInstance] start];
//Start the Rich Logic
[[DRLogicMainController sharedInstance] start];
//Initialise Donky
[[DNDonkyCore sharedInstance] initialiseWithAPIKey:@"API-Key"];
return YES;
}您还必须调用您的应用程序代理的以下方法
以确保您的设备令牌被发送到Donky网络
- (void)application:(UIApplication *)application didRegisterForRemoteNotificationsWithDeviceToken:(NSData *)deviceToken {
[DNNotificationController registerDeviceToken:deviceToken];
}为了处理传入的通知，使用此方法可以让您的应用程序处理内容通知
- (void)application:(UIApplication *)application didReceiveRemoteNotification:(NSDictionary *)userInfo fetchCompletionHandler:(void (^)(UIBackgroundFetchResult result))completionHandler {
[DNNotificationController didReceiveNotification:userInfo handleActionIdentifier:nil completionHandler:^(NSString *string) {
completionHandler(UIBackgroundFetchResultNewData);
}];
}为了处理交互式通知（仅限iOS 8+）
- (void)application:(UIApplication *)application handleActionWithIdentifier:(NSString *)identifier forRemoteNotification:(NSDictionary *)userInfo completionHandler:(void (^)())completionHandler {
[DNNotificationController didReceiveNotification:userInfo handleActionIdentifier:identifier completionHandler:^(NSString *string) {
completionHandler();
}];
}##示例
示例项目可以在以下位置找到
�
����src
����workspaces
����Donky Rich Message Logic Demo
要求
- iOS 8.0+
- 必须启用 Arc。
安装
pod "Donky-RichMessage-Logic"
Pod 依赖
在 podfile 中包含以下内容将自动导入以下其他模块，因为它们是硬依赖，无需手动包含以下任何一项。
- Donky 核心SDK
- Donky 常用消息逻辑
Donky-RichMessage-Inbox
使用说明
使用富文本消息模块，使您的应用程序能够在预构建的UI中接收和显示富文本消息。
##示例
示例项目可以在以下位置找到
�
����src
����workspaces
����Donky Rich Message Inbox Demo
要求
- iOS 8.0+
- 必须启用 Arc。
安装
pod "Donky-RichMessage-Inbox"
Pod 依赖项
在 podfile 中包含以下内容将自动导入以下其他模块，因为它们是硬依赖，无需手动包含以下任何一项。
- Donky 核心SDK
- Donky 富文本消息逻辑
- Donky 常用消息逻辑
- Donky通用消息UI
Donky-Automation-Logic
使用说明
使用自动化模块，以便在Campaign Builder/Donky Control中此处触发活动设置。
正常启动Donky SDK和分析控制器。
- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
// Override point for customization after application launch.
//Start analytics module (optional)
[[DCAAnalyticsController sharedInstance] start];
//Initialise Donky
[[DNDonkyCore sharedInstance] initialiseWithAPIKey:@"API-KEY"];
return YES;
}要触发触发器，可以使用以下任一方法
[DAAutomationController executeThirdPartyTriggerWithKey:@"Trigger-Key" customData:@{}];[DAAutomationController executeThirdPartyTriggerWithKeyImmediately:@"Trigger-Key" customData:@{}];##示例
示例项目可以在以下位置找到
�
����src
����workspaces
����Donky Automation Demo
要求
- iOS 8.0+
- 必须启用 Arc。
安装
pod "Donky-Automation-Logic"
Pod 依赖
在 podfile 中包含以下内容将自动导入以下其他模块，因为它们是硬依赖，无需手动包含以下任何一项。
- Donky 核心SDK
Donky-通用消息-音频
用法
使用本模块允许您针对各种消息类型保存音频文件，并在接收到该类型消息时自动播放。此处。
启动控制器
- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
// Override point for customization after application launch.
[[DAMainController sharedInstance] start];
//Other donky modules or custom code:
return YES;
}要设置音频文件，此方法接受对该文件的 NSURL。
[[DAMainController sharedInstance] setAudioFile:<#(NSURL *)#> forMessageType:<#(DonkyAudioMessageTypes)#>];播放音频文件
[[DAMainController sharedInstance] playAudioFileForMessage:<#(DonkyAudioMessageTypes)#>];##示例
�
����src
����workspaces
����Donky Audio
要求
- iOS 8.0+
- 必须启用 Arc。
安装
pod "Donky-CommonMessaging-Audio"
Pod 依赖
无
Donky-Core-排序
使用
使用此模块可以使您在切换本地和网络状态时，无需实现调用回调和担心顺序，就执行多个对某些账户控制器方法的调用。
该模块覆盖了下述方法
DNSequencingAccountController+ (void)updateAdditionalProperties:(NSDictionary *)newAdditionalProperties success:(DNNetworkSuccessBlock)successBlock failure:(DNNetworkFailureBlock)failureBlock;+ (void)saveUserTags:(NSMutableArray *)tags success:(DNNetworkSuccessBlock)successBlock failure:(DNNetworkFailureBlock)failureBlock;+ (void)updateUserDetails:(DNUserDetails *)userDetails success:(DNNetworkSuccessBlock)successBlock failure:(DNNetworkFailureBlock)failureBlock;+ (void)updateRegistrationDetails:(DNUserDetails *)userDetails deviceDetails:(DNDeviceDetails *)deviceDetails success:(DNNetworkSuccessBlock)successBlock failure:(DNNetworkFailureBlock)failureBlock;+ (void)updateDeviceDetails:(DNDeviceDetails *)deviceDetails success:(DNNetworkSuccessBlock)successBlock failure:(DNNetworkFailureBlock)failureBlock;##示例
需求
- iOS 8.0+
- 必须启用 Arc。
安装
pod "Donky-Core-Sequencing"
Pod 依赖
在 podfile 中包含以下内容将自动导入以下其他模块，因为它们是硬依赖，无需手动包含以下任何一项。
- Donky 核心SDK
Donky-常用消息逻辑
使用
您永远不需要手动将常用逻辑模块添加到您的应用程序中，它是一个 PodSpec 依赖项，因此不需要手动添加到您的 PodFile 中。
Donky-CommonMessaging-UI
使用方法
您不需要手动将公共UI模块添加到您的应用程序中，它是一个PodSpec依赖项，因此无需手动添加到您的PodFile中。
Donky-CoreLocation
使用方法
添加此选项，您可以使用Donky的位置和报告功能，请参见此处