Donky Modular SDK (V2.8.6.4)
Donky iOS SDK 是一个用于将推送通知和丰富内容服务添加到您的应用程序的工具包。有关详细文档、教程和指南，请访问我们的在线 文档。
##要求
Donky Modular SDK 的最低技术要求如下
- Xcode 6.0+
- iOS 8.0+
- 必须启用弧光。
- 集成时，应将库作为 Cocoa Touch Framework 包含进来
通过 CocoaPods 导入
如果使用 Cocoapods，请在您的 Podfile 中包含 use_frameworks!。由于库的构建方式，当 SDK 作为静态库使用时，无法导入其内部使用的某些资源。Framework 是将外部库包含到项目中的现代方式，也是 Swift 支持的要求，因此请使用这种方法来集成龙骨 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
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+
- 必须启用弧光。
第三方依赖
安装
Donky-Core-SDK通过CocoaPods提供。要安装它，只需将以下行添加到Podfile中
pod "Donky-Core-SDK"Donky-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+
- 必须启用弧光。
- 针对交互式通知，iOS 8.0+是必需的。
安装
pod "Donky-Push"Pod依赖
将以下模块包含在您的Podfile中将会自动拉取以下其他模块，因为它们是强制依赖项。无需手动包含以下任何模块
- Donky Core 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+
- 必须启用弧光。
安装
pod "Donky-RichMessage-Logic"
Pod 依赖
将以下模块包含在您的Podfile中将会自动拉取以下其他模块，因为它们是强制依赖项。无需手动包含以下任何模块
- Donky Core SDK
- Donky 常用消息逻辑
Donky-RichMessage-Inbox
使用方法
使用富消息模块来使您的应用能够在我们的预设UI中接收和显示富消息。
##示例
示例项目可在此找到
�
����src
����workspaces
����Donky Rich Message Inbox Demo
要求
- iOS 8.0+
- 必须启用弧光。
安装
pod "Donky-RichMessage-Inbox"
Pod 依赖
将以下模块包含在您的Podfile中将会自动拉取以下其他模块，因为它们是强制依赖项。无需手动包含以下任何模块
- Donky Core 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+
- 必须启用弧光。
安装
pod "Donky-Automation-Logic"
Pod 依赖
将以下模块包含在您的Podfile中将会自动拉取以下其他模块，因为它们是强制依赖项。无需手动包含以下任何模块
- Donky Core 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+
- 必须启用弧光。
安装
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+
- 必须启用弧光。
安装
pod "Donky-Core-Sequencing"
Pod 依赖
将以下模块包含在您的Podfile中将会自动拉取以下其他模块，因为它们是强制依赖项。无需手动包含以下任何模块
- Donky Core SDK
Donky-CommonMessaging-Logic
使用
您永远不需要手动将通用逻辑模块添加到您的应用程序中，它是一个 PodSpec 依赖项，因此无需手动添加到您的 PodFile 中。
Donky-通用消息-UI
使用
您永远不需要手动将通用 UI 模块添加到您的应用程序中，它是一个 PodSpec 依赖项，因此无需手动添加到您的 PodFile 中。
Donky-核心位置
使用
添加此依赖项将允许您使用 Donky 位置和报告功能，请参阅此处