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
使用
使用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-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"
模块依赖关系
无
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"
模块依赖关系
在 podfile 中包含以下内容将自动拉入以下其他模块，因为它们是硬依赖。无需手动包含以下任何内容
- Donky 核心SDK
Donky-CommonMessaging-Logic
使用方法
您永远不需要手动将通用逻辑模块添加到您的应用程序中，它是一个 PodSpec 依赖项，因此不需要手动添加到 PodFile 中。
Donky-CommonMessaging-UI
使用方法
您永远不需要手动将通用 UI 模块添加到您的应用程序中，它是一个 PodSpec 依赖项，因此不需要手动添加到 PodFile 中。
Donky-CoreLocation
使用方法
添加此依赖将允许您使用 Donky 的位置和报告功能，请参阅此处