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!。由于库的构造方式，无法在将其作为静态库使用时导入一些内部使用的资源。框架是包含外部库的现代方式，也是 Swift 支持的要求，因此请使用此方式集成 Donky SDK。
请在此处阅读我们的完整文档 http://docs.mobiledonky.com
作者
Donky Networks Ltd，[email protected]
授权
DonkySDK-iOS-Modular遵循MIT许可协议。有关更多信息，请参阅LICENSE文件。
##安装
请使用以下方法之一进行安装：
克隆Git仓库
git clone [email protected]:Donky-Network/DonkySDK-iOS-Modular.git
使用 CocoaPods
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](https://cocoapods.org.cn)获取。为了安装它，只需将以下行添加到您的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"Pods依赖
将此内容加入您的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-CommonMessaging-Audio
用法
使用此模块，您可以针对不同类型的消息保存音频文件，并允许在接收到该类型消息时自动播放。详情请见这里。
启动控制器
- (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-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的定位和报告功能，请参阅此处