Donky Modular SDK (V2.8.6.4)
Donky iOS SDK 是一个用于将推送通知和丰富内容服务添加到您的应用的工具包。有关详细文档、教程和指南,请访问我们的在线文档。
##需求
Donky Modular SDK 的最小技术需求是:
- Xcode 6.0+
- iOS 8.0+
- 必须启用 Arc。
- 集成时,应将库作为 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
}
您还必须调用应用程序的以下代理,以确保及时收到并处理自定义内容通知。
确保您的设备token被发送到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;
}
你还必须调用以下应用程序的代理
确保您的设备token被发送到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 Core SDK
- Donky通用消息逻辑
使用富消息模块,您的应用程序可以接收来自网络的富消息并存入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;
}
你还必须调用以下应用程序的代理
确保您的设备token被发送到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"
将此内容包含在您的Podfile中,将自动引入以下其他模块,因为它们具有强硬依赖性。无需手动包含以下任意一项。
- Donky Core SDK
- Donky通用消息逻辑
用法
使用富消息模块,以使您的应用程序能够在我们预先构建的UI中接收和显示富消息。
##示例
示例项目可在此找到:
�
����src
����workspaces
����Donky Rich Message Inbox Demo
需求
- iOS 8.0+
- 必须启用 Arc。
安装
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+
- 必须启用 Arc。
安装
pod "Donky-Automation-Logic"
Pod依赖
将此内容包含在您的Podfile中,将自动引入以下其他模块,因为它们具有强硬依赖性。无需手动包含以下任意一项。
- Donky Core SDK
Donky-通用消息音频
使用方法
使用此模块可以让你对各种消息类型保存音频文件,并在接收到此类消息时自动播放它们。[在此处](http://docs.mobiledonky.com)。
启动控制器
- (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 Core SDK
Donky-CommonMessaging-Logic
用法
您永远不需要手动将通用逻辑模块添加到您的应用中,它是一个 PodSpec 依赖项,因此不需要手动添加到 PodFile 中。
Donky-CommonMessaging-UI
用法
您永远不需要手动将通用 UI 模块添加到您的应用中,它是一个 PodSpec 依赖项,因此不需要手动添加到 PodFile 中。
Donky-CoreLocation
用法
添加此模块将允许您使用 Donky 的位置和报告功能,请参阅此处