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 Request！
##CocoaPods
Donky-Core-SDK
使用方法
如果只使用SDK的一部分，请仅在您的`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
用法
使用 Simple Push 模块使您的应用程序能够接收 Simple 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 自动化逻辑
用法
使用自动化模块在 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"
环境依赖
将此设置添加到您的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"
环境依赖
无
Donky-Core-Sequencing
用法
使用本模块，您可以在不实现回调或无需考虑更改本地和网络状态下的顺序的情况下对某些账号控制器方法进行多次调用。
本模块覆盖以下方法内部：
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-CommonMessaging-Logic
用法
您无需手动将通用逻辑模块添加到您的应用程序中，它是一个 PodSpec 依赖项，因此不需要手动添加到您的 PodFile 中。
Donky-CommonMessaging-UI
使用方法
您不需要手动将通用UI模块添加到您的应用程序中，它是一个PodSpec依赖项，因此不需要手动添加到PodFile中。
Donky-CoreLocation
使用方法
添加此模块后，您可以使用Donky的位置和报告功能，请参阅此处