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。
请在此处阅读我们的完整文档 here
作者
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'中。如果您需要使用任何其他可选模块，则无需这样做。
匿名初始化
- (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"
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-通用消息-UI
使用
您无需手动将通用UI模块添加到您的应用程序中，它是一个PodSpec依赖项，因此无需手动添加到PodFile中。
Donky-核心定位
使用
添加此功能将允许您使用Donky的定位和报告，请参阅此处