Donky-Core-SDK 4.8.6.4

Donky-Core-SDK 4.8.6.4

×

测试已测试✗
Lang语言 Obj-CObjective C
许可协议 MIT
Released上次发布2018年12月

由 Donky Networks Ltd，Ben Moore，Dominik Kowalski 维护。

Donky-Core-SDK 4.8.6.4

Donky Networks LTD

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 作为 Static Library 使用时无法导入一些内部使用的资源。框架是包含外部库的现代方式，同时也是支持 Swift 的要求，因此请使用此方式集成 Donky 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

使用 CocoaPods

Please see below for all the information specific to the CocoaPods

##支持

如果您在集成或使用此 SDK 时遇到任何问题，请联系 [email protected]

##贡献

我们接受 pull request！

##CocoaPods

Donky-Core-SDK

Version License Platform Docs

使用

仅当 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 必须启用。

第三方依赖

AFNetworking

安装

Donky-Core-SDK 通过 CocoaPods 提供使用。要安装它，只需将以下行添加到您的 Podfile 中

pod "Donky-Core-SDK"

Donky-Push

Version License Platform Docs

用法

使用 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

Version License Platform Docs

使用方法

使用富消息模块，使您的应用程序能够从网络中接收富消息并保存到 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

Version License Platform Docs

用法

使用富消息模块，使您的应用程序能够在我们的预构建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-Automation-Logic

Version License Platform Docs

用法

使用自动化模块，使您能够在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

Version License Platform Docs

使用

使用此模块，您可以将音频文件与各种消息类型关联，允许在收到该类型的消息时自动播放。详见此处。

启动控制器

- (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

Version License Platform Docs

用法

该模块允许您无需实现回调或在改变本地和网络状态时担心顺序，即可多次调用某些账户控制器方法。

该模块覆盖以下方法内部

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

Version License Platform Docs

使用方法

您永远不需要手动将通用逻辑模块添加到您的应用程序中，它是PodSpec依赖项，因此不需要手动添加到PodFile中。

Donky-CommonMessaging-UI

Version License Platform Docs

使用方法

您永远不需要手动将通用UI模块添加到您的应用程序中，它是PodSpec依赖项，因此不需要手动添加到PodFile中。

Donky-CoreLocation

Version License Platform Docs

使用方法

添加此功能将允许您使用Donky的位置和报告功能，请参阅这里