dongtuStore

立即使用

概述

本模块封装了表情商店SDK

关于表情云

表情SaaS服务SDK是动图宇宙对自己的技术及内容的封装,并提供给广大开发者使用的一个套件,解决了开发者在表情动图领域的版权、内容、运营及技术方面的需求。提供两种接入类型的SDK:表情商店SDK、动图宇宙SDK。

注意:此模块需要全屏frame或win使用否则会出现未知问题。

特性

  • 海量表情动图图库,每天更新
  • 1000+热门IP,正版资源保障

注意:本模块 iOS 平台上最低适配系统版本为 iOS 9.0

使用此模块之前必须先配置 config 文件,配置方法如下:

  • 名称:dongtuStore
  • 参数:appId、appSecret
  • 配置示例:
  <feature name="dongtuStore">
    <param name="appId" value="" />
    <param name="appSecret" value="" />
    <param name="userId" value="" />
    <param name="name" value="" />
    <param name="phone" value="" />
    <param name="email" value="" />
    <param name="address" value="" />
    <param name="gender" value="" />
  </feature>
  • 字段描述:

    appId:应用的App ID,开发者后台获取

    appSecret: 应用的App ID,开发者后台获取

    userId:用户id

    name:用户名

    phone:电话

    email:邮件

    address:地址

    gender:(可选项)用户性别 1:男,2:女;默认:1

模块接口

open

打开输入框页面

open({params}, callback(ret))

params

rect:

  • 类型:JSON 对象
  • 描述:采集画面的位置及尺寸
  • 内部字段:
{
    x: 0,   // 数字类型;模块左上角的 x 坐标(相对于所属的 Window 或 Frame);默认值:0
    w: 320, // 数字类型;模块的宽度;iOS支持设置'auto';默认值:所属的 Window 或 Frame 的宽度
    h: 50  // 数字类型;模块的高度;iOS支持设置'auto';默认值:50
}

fixedOn:

  • 类型:字符串
  • 描述:(可选项)模块所属 Frame 的名字,若不传则模块归属于当前 Window

fixed:

  • 类型:布尔
  • 描述:(可选项)模块是否随所属 Window 或 Frame 滚动
  • 默认值:true(不随之滚动)

callback(ret,err)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
       eventType: '', //字符串类型;事件回掉;取值范围如下:
                    //gif:gif图
                        //bigFace:点击大表情
                        //send:点击发送按钮
      gif:{  //json对象,eventType = gif返回
          imageId:'', //字符串类型;图片id
          text:'', //字符串类型;图片名称
          thumbImage:'', //字符串类型;图片缩略图地址(仅iOS支持)
          gifThumbImage:'', //字符串类型;图片缩略图地址动图(仅iOS支持)
          mainImage:'', //字符串类型;图片地址,可能是GIF、PNG、JPG格式
          isAnimated:'', //布尔类型;是否是动态图片
          size:{ //json对象;图片尺寸
           w:0,//数字类型;宽
           h0 //数字类型;高
          }

      },    
      bigFace:{ //json对象,eventType = bigFace返回
         emojiId:'', //字符串类型;emoji id{仅iOS支持}
          emojiName:'', //字符串类型;emoji name
          emojiCode:'', //字符串类型;emoji code
          packageId:'', //字符串类型;package id{仅iOS支持}
          emojiImage:'', //字符串类型;emoji image{仅iOS支持}
          isEmoji:'', //布尔类型;is small emoji{仅iOS支持}
      },
      send:{ //json对象,eventType = send返回
        text:''  //字符串类型,文本消息
      },                    
}

示例代码

var dongtuStore = api.require('dongtuStore');
dongtuStore.open({
},function(ret){
    alert(JSON.stringify(ret));
});

可用性

iOS、Android系统

可提供的1.0.0及更高版本

close

关闭输入框页面

close()

示例代码

var dongtuStore = api.require('dongtuStore');
dongtuStore.close();

可用性

iOS、Android系统

可提供的1.0.0及更高版本

hide

隐藏输入框页面

hide()

示例代码

var dongtuStore = api.require('dongtuStore');
dongtuStore. hide();

可用性

iOS、Android系统

可提供的1.0.0及更高版本

show

显示输入框页面

show()

示例代码

var dongtuStore = api.require('dongtuStore');
dongtuStore.show();

可用性

iOS、Android系统

可提供的1.0.0及更高版本

clearCache

清除缓存,此操作会删除所有临时的表情缓存,已下载的表情包不会被删除

clearCache()

示例代码

var dongtuStore = api.require('dongtuStore');
dongtuStore.clearCache();

可用性

iOS、Android系统

可提供的1.0.0及更高版本