# 快速上手

提示

AIHelp 支持 C++ 和蓝图两种方式接入，你可以根据具体的情况灵活选择适合你的接入方式。

本文档中的代码均以 C++ 为例作展示。

# 接入

下载 (opens new window) AIHelp 提供的 AIHelpForUE 插件，并将其导入你的工程即可。

需要注意的是，AIHelp Unreal Plugin 是对原生 Android 以及 iOS 的封装，并提供了相应的桥接文件。其中，Android 使用 Gradle 添加依赖，iOS 提供了 framework 静态库。

# Android

使用 Gradle 工具进行 AIHelp Android SDK 的依赖接入，你可以在 AIHelpForUE/AIHelp_UPL.xml 中找到相关依赖：

dependencies {
    implementation 'net.aihelp:android-aihelp-aar:4.6.+'
}

AIHelp 使用到的类库有 androidx.recyclerView、okhttp3、okio，如果使用 aar 的方式接入，请确保有相关类库的依赖。

# iOS

iOS 内部依赖了 .framework 静态库，你可以在 Plugins/AIHelpForUE/Source/ThirdParty/ 目录下找到相关文件。

1、在项目工程的 info.plist 中增加权限：Privacy - Photo Library Usage Description，否则可能无法正常使用图片上传功能；

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

# API

注意

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

# Init()

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

if (USER_FROM_MAINLAND_CHINA) {
    FAIHelpForUEModule::Get().GetAIHelp()->AdditionalSupportFor(EAIHelpPublishCountryOrRegion::China);
}
FAIHelpForUEModule::Get().GetAIHelp()->Init(
    "THIS IS YOUR APP KEY",
    "THIS IS YOUR APP DOMAIN",
    "THIS IS YOUR APP ID",
    "THIS IS YOUR DEFAULT LANGUAGE(OPTIONAL)"
);

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

# SetOnAIHelpInitializedCallback()

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

void onAIHelpInit(bool isSuccess, FString Message) {
    // do something you want
}
FAIHelpForUEModule::Get().GetAIHelp()->SetOnAIHelpInitializedCallback(onAIHelpInit);

# 参数释义

# appKey / domain / appId

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

# language

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

# FOnAIHelpInitializedDelegate

类型：void (*OnAIHelpInitializedCallback)(bool isSuccess, FString Message)
默认值：NULL
详情：可选参数。 SDK 的初始化回调，当初始化成功时会回调此方法。

# 代码示例

请确保在应用启动或首屏进行 SDK 的初始化工作。

具体代码示例如下所示：

void onAIHelpInit(bool isSuccess, FString Message) {
    // do something you want
}

if(USER_FROM_MAINLAND_CHINA){
    FAIHelpForUEModule::Get().GetAIHelp()->AdditionalSupportFor(EAIHelpPublishCountryOrRegion::China);
}
FAIHelpForUEModule::Get().GetAIHelp()->Init(
    "THIS IS YOUR APP KEY",
    "THIS IS YOUR APP DOMAIN",
    "THIS IS YOUR APP ID",
    "THIS IS YOUR DEFAULT LANGUAGE(OPTIONAL)"
);        
FAIHelpForUEModule::Get().GetAIHelp()->SetOnAIHelpInitializedCallback(onAIHelpInit);

智能客服 →