测试已测试 | ✗ |
语言语言 | Obj-CObjective C |
许可证 | MIT |
发布最后发布 | 2016年2月 |
由 Donky Networks Ltd 维护。
Donky iOS SDK 是用于向您的应用程序添加推送通知和丰富内容服务的工具包。有关详细文档、教程和指南,请访问我们的在线 文档。
Donky Module SDK 的最低技术要求是
请在这里阅读我们的完整文档 here
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]。
我们接受合并请求!
仅当您要使用 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
Donky-Core-SDK 可通过 CocoaPods 获取。要安装它,只需将以下行添加到您的 Podfile 中
pod "Donky-Core-SDK"
使用简单推送模块,让您的应用程序能够接收简单推送消息。
- (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
pod "Donky-SimplePush-Logic"
包含此内容到您的 podfile 将自动拉取以下其他模块,因为它们是硬依赖的。不需要手动添加以下任何模块
使用富消息模块,让您的应用程序能够从网络接收富消息并将其保存在 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
pod "Donky-RichMessage-Logic"
包含此内容到您的 podfile 将自动拉取以下其他模块,因为它们是硬依赖的。不需要手动添加以下任何模块
使用富消息模块,让您的应用程序能够在我们预构建的 UI 中接收和显示富消息。
示例项目可以找到
│
├───src
├───workspaces
├───Donky Rich Message Inbox Demo
pod "Donky-RichMessage-Inbox"
包含此内容到您的 podfile 将自动拉取以下其他模块,因为它们是硬依赖的。不需要手动添加以下任何模块
使用自动化模块来启用在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
pod "Donky-Automation-Logic"
包含此内容到您的 podfile 将自动拉取以下其他模块,因为它们是硬依赖的。不需要手动添加以下任何模块
使用本模块可以让你针对各种消息类型保存音频文件,并在接收到此类消息时自动播放。此处了解更多。
启动控制器
- (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
pod "Donky-CommonMessaging-Audio"
无
使用此模块可以在不实现回调或不用担心改变本地和网络状态时的顺序的情况下,对某些账户控制器方法执行多次调用。
此模块覆盖了以下方法内部
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;
pod "Donky-Core-Sequencing"
包含此内容到您的 podfile 将自动拉取以下其他模块,因为它们是硬依赖的。不需要手动添加以下任何模块
您永远不需要手动将公共逻辑模块添加到您的应用程序中,它是一个PodSpec依赖项,因此不需要手动添加到您的PodFile中。
您永远不需要手动将公共UI模块添加到您的应用程序中,它是一个PodSpec依赖项,因此不需要手动添加到您的PodFile中。