# 快速上手

# 接入

注意

在接入前,请确保对项目工程进行如下配置,否则可能导致程序 crash。

1、在 info.plist 中添加 Privacy - Photo Library Usage Description 配置;

2、在 info.plist 中添加 PHPhotoLibraryPreventAutomaticLimitedAccessAlert 配置,并将其设置为 YES

3、在 Xcode 的 TARGETS > Build Phrases > Link Binary with libraries 下添加 PhotosUI.framework 系统库;

# 手动导入

1、下载 GitHub Tags 列表 (opens new window)中 3.x 版本中最新的版本,并导入工程中即可;

2、打开 Xcode 的 Build Settings 页面,搜索 Other Linker Flags 字段并为其添加 -ObjC 配置;

# Cocoapods

使用 Cocoapods 导入 AIHelp SDK:

pod 'AIHelpSDK', '~> 3.4.0'

# API

注意

你应该在应用启动或首屏进行 AIHelp SDK 的初始化,否则有可能出现不可控制的异常,并面临服务被停用及其他商业风险。

# init

你可以通过调用此方法来开始 AIHelp 的初始化工作:

if (USER_FROM_MAINLAND_CHINA) {
    [AIHelpSupportSDK additionalSupportFor:AIHelpCN];
}
[AIHelpSupportSDK initWithApiKey:@"THIS IS YOUR APP KEY"
                  domainName:@"THIS IS YOUR APP DOMAIN"
                  appId:@"THIS IS YOUR APP ID"
                  language:@"THIS IS YOUR DEFAULT LANGUAGE(OPTIONAL)"];

为了保证玩家的服务体验,AIHelp 建议你为特定国家或地区的用户配置额外的域名支持

# setOnInitializedCallback

同时,我们也提供了 API 来监听 SDK 的初始化情况:










 



#import <AIHelpSupportSDK/AIHelpSupportSDK.h>
...

void AIHelp_onInitializationCallback() {
    // do something you want
}

- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions
{
    [AIHelpSupportSDK setOnInitializedCallback:AIHelp_onInitializationCallback];
    return YES;
}

# 参数释义

# appKey / domain / appId

  • 类型:NSString
  • 详情:必传参数。 初始化相关参数信息,可以在 AIHelp 后台图示位置得到:

# language

  • 类型:NSString
  • 默认值:当前设备语言
  • 详情:可选参数。 SDK 的默认语言;如果不传,则会使用当前设备语言初始化 SDK。多语言怎么办?

# onAIHelpInitializedCallback

  • 类型:(void(*)(void)
  • 默认值:nil
  • 详情:可选参数。 SDK 的初始化回调,当初始化成功时会回调此方法。

# 代码示例

请确保在你的 AppDelegate.m(推荐) 的 application: didFinishLaunchingWithOptions: 方法中进行 SDK 的初始化工作。

你可以通过调用 AIHelpSupportSDKinit 方法开始 AIHelp 的初始化工作。

具体代码示例如下所示:

 








 
 
 
 
 
 
 
 



#import <AIHelpSupportSDK/AIHelpSupportSDK.h>
...

void AIHelp_onInitializationCallback() {
    // do something you want
}

- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions
{
    if (USER_FROM_MAINLAND_CHINA) {
        [AIHelpSupportSDK additionalSupportFor:AIHelpCN];
    }
    [AIHelpSupportSDK initWithApiKey:@"THIS IS YOUR APP KEY"
                      domainName:@"THIS IS YOUR APP DOMAIN"
                      appId:@"THIS IS YOUR APP ID"
                      language:@"THIS IS YOUR DEFAULT LANGUAGE(OPTIONAL)"];
    [AIHelpSupportSDK setOnInitializedCallback:AIHelp_onInitializationCallback];
    return YES;
}
上次更新: 4/2/2024, 11:39:51 AM