跳到主要内容

Cocos接入文档

1、简介​

本文档主要介绍在Cocos Creator 2.x.x及以上版本中如何集成和使用SDK，根据⽂档操作即可⾼效的完成SDK的接⼊，该文档仅供研发接入参考。

2、SDK快速接入​

2.1.1 Android​

  • minSdkVersion ≥ 21（Android 5.0 或更高版本）
  • Java 8或更高版本
  • AndroidX 支持
  • Cocos Creator 2.x.x 及以上版本

2.1.2 iOS​

  • iOS 9及以上版本
  • Cocos Creator 3.0.0 及以上版本

2.2 SDK集成​

3、SDK接口使用说明​

3.1 初始化接口​

TOPCustomerService.init(appId: string);

该接⼝⽤于进⾏SDK初始化操作，务必在调⽤SDK其他接⼝前调用。

参数：

key含义类型
appId每款应用在平台的唯一标识，由平台分配string

返回结果：无

3.2 客服中心显示接口​

TOPCustomerService.enter(info: TOPCustomerServiceInfo);

该接⼝⽤于显示客服中心界面接口。

参数：

key含义类型
info客服中心信息实体类TOPCustomerServiceInfo

TOPCustomerServiceInfo实体类：

key含义类型是否必传
roleId角色Id，用于标识玩家/角色的唯一Id。重要参数，用于区分用户，如果无法获取到用户信息可传空，如：未登录场景string否
roleName角色名称，长度不超过255string否
extraJson自定义参数，必须为Json格式字符串，请勿传入用户隐私数据（例：设备唯一标识、mac地址等）string否

注：以上参数信息用于在客服后台查询并定位到玩家。

返回结果： 无

接口调用示例

let info = new TOPCustomerServiceInfo(roleId: string, roleName: string, extraJson: string);
roleId:"角色ID";
roleName:"角色名称"; 
extraJson:"自定义参数"; //如果游戏需要传入自定义参数，请传入json格式字符串
TOPCustomerService.enter(info); //打开客服中心

自定义参数json字符串示例："{\"level\":\"1\",\"level_progress\":\"关卡1-5\"}"

4、导出原生项目说明​

4.1 导出AndroidStudio项目​

1、 导出AndroidStudio项目

2、 请把下载的sdk包中的libs下的文件复制到游戏AndroidStudio项目libservice目录下

3、 启用AndroidX配置，在项目的gradle.properties添加配置以下代码：

android.useAndroidX=true
android.enableJetifier=true

androidx

4、 添加以下SDK依赖库到项目外层build.gradle配置文件，如下所示：

repositories {
    maven { url 'https://storage-sdk-gameplus.meetsocial.com/repository/TopSdk/' }
}

cocos-1

5、 添加以下SDK依赖到library模块的build.gradle配置文件，如下所示：

  //模块依赖
  dependencies {
    //cocos creator 请添加依赖 x.x.x.x为SDK版本号，如1.3.0.1
    implementation 'com.sino.topsdk:customerservice:x.x.x.x'
    //android系统依赖，如果游戏工程已经导入了appcompat配置，则不用添加
    implementation 'androidx.appcompat:appcompat:1.2.0' 
  }

cocos-2

6、权限申请

请将以下内容全部复制到AndroidManifest.xml的manifest标签下

//读写SD卡权限是用于客服发送照片   
<uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE"/>

4.2 导出Xcode工程​