# 快速上手

# 接入

推荐使用 Gradle 平台进行 AIHelp SDK 的依赖接入:

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

AIHelp 使用到的类库有 androidx.recyclerViewokhttp3okio,如果使用 aar 的方式接入,请确保有相关类库的依赖。

# API

注意

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

# init()

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

if (USER_FROM_MAINLAND_CHINA) {
    AIHelpSupport.additionalSupportFor(PublishCountryOrRegion.CN);
}
AIHelpSupport.init(this,
        "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 的初始化情况:






 



 
 
 



public class App extends Application implements OnAIHelpInitializedCallback {

    @Override
    public void onCreate() {
        super.onCreate();
        AIHelpSupport.setOnAIHelpInitializedCallback(this);
    }

    @Override
    public void onAIHelpInitialized() {
        // when init job is done, you can get callback here.
    }

}

# 参数释义

# context

  • 类型:Context
  • 详情:必传参数。 当前页面的上下文信息,一般为 Activity 或 Application 对象。

# appKey / domain / appId

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

# language

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

# onAIHelpInitializedCallback

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

# 代码示例

请确保在你的 Application(推荐)或者首屏 Activity 的 onCreate() 方法中进行 SDK 的初始化工作。

具体代码示例如下所示:







 
 
 
 
 
 
 
 
 
 

 
 
 
 









 
 
 
 
 
 
 
 
 


 
 
 
 



// init SDK in Application.java(recommended)
public class App extends Application implements OnAIHelpInitializedCallback {

    @Override
    public void onCreate() {
        super.onCreate();
        if (USER_FROM_MAINLAND_CHINA) {
            AIHelpSupport.additionalSupportFor(PublishCountryOrRegion.CN);
        }
        AIHelpSupport.init(this,
                "THIS IS YOUR APP KEY",
                "THIS IS YOUR APP DOMAIN",
                "THIS IS YOUR APP ID",
                "THIS IS YOUR DEFAULT LANGUAGE(OPTIONAL)");
        AIHelpSupport.setOnAIHelpInitializedCallback(this);
    }

    @Override
    public void onAIHelpInitialized() {
        // when init job is done, you can get callback here.
    }

}

// init SDK in MainActivity.java
public class MainActivity extends Activity implements OnAIHelpInitializedCallback {

  @Override
    protected void onCreate(@Nullable Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        if (USER_FROM_MAINLAND_CHINA) {
            AIHelpSupport.additionalSupportFor(PublishCountryOrRegion.CN);
        }
      	AIHelpSupport.init(this,
                "THIS IS YOUR APP KEY",
                "THIS IS YOUR APP DOMAIN",
                "THIS IS YOUR APP ID",
                "THIS IS YOUR DEFAULT LANGUAGE(OPTIONAL)");
        AIHelpSupport.setOnAIHelpInitializedCallback(this);
    }

  	@Override
    public void onAIHelpInitialized() {
        // when init job is done, you can get callback here.
    }

}
上次更新: 11/8/2023, 3:45:06 AM