Donky Modular SDK (V2.8.6.4)
Donky iOS SDK 是一款用于向您的应用程序添加推送通知和丰富内容服务的工具包。有关详细的文档、教程和指南，请访问我们的在线 文档。
##要求
Donky Modular SDK 的最低技术要求为
- Xcode 6.0+
- iOS 8.0+
- 必须启用 Arc。
- 当通过 CocoaPods 集成时，应将库作为 Cocoa Touch 框架包含
通过 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 通用消息界面
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-核心-排序
使用
使用此模块，您可以对一些账户控制器方法进行多次调用，而无需实现回调和担心在改变本地和网络状态时的序列问题。
该模块覆盖以下方法中的以下方法
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的位置和报告功能，请参阅此处