SDK文档
<h3>概述</h3>
<p>该部分接口的入口类为 <strong>SearchWordMgr</strong>,在调用该部分接口前,需要打开sdk和license认证通过,否则有可能会导致部分功能无法正常work。</p>
<h3>1.初始化SDK</h3>
<p><strong>接口名称:</strong></p>
<pre><code class="language-java">public SearchWordMgr init()</code></pre>
<p><strong>备注:在application oncreate中只初始化一次</strong></p>
<h3>2.设置接口回调</h3>
<pre><code class="language-java">public SearchWordMgr setISearchWordCallback(ISearchWordCallback iSearchWordCallback)</code></pre>
<h4>2.1 ISearchWordCallback介绍</h4>
<p>ISearchWordCallback是数据结果的返回,有两个方法onSearchWordInfoSuccess和onSearchFail;</p>
<p><strong>方法名称:</strong></p>
<pre><code class="language-java"> /**
* 请求失败,字词数据返回失败
* @param code 错误码
* @param msg 错误信息
*/
void onSearchFail(int code, String msg);
/**
* 字词数据返回成功
* @param data 数据返回结构数据bean
*/
void onSearchWordInfoSuccess(DictionaryVO dictionaryVO);
</code></pre>
<h4>2.2 onSearchWordInfoSuccess回调的DictionaryVO介绍</h4>
<table>
<thead>
<tr>
<th>参数</th>
<th>类型</th>
<th>说明</th>
</tr>
</thead>
<tbody>
<tr>
<td>id</td>
<td>Long</td>
<td>字词ID</td>
</tr>
<tr>
<td>fatherId</td>
<td>Long</td>
<td>父ID</td>
</tr>
<tr>
<td>text</td>
<td>String</td>
<td>文本</td>
</tr>
<tr>
<td>type</td>
<td>Integer</td>
<td>类型,1汉字 2词语 3成语 4古诗名 5古诗句 6英语单词 7英语短语</td>
</tr>
<tr>
<td>zhBase</td>
<td>array</td>
<td>汉字的基础信息,结构笔画等</td>
</tr>
<tr>
<td>zhInfos</td>
<td>array</td>
<td>汉字、词语、成语的详细信息</td>
</tr>
<tr>
<td>poemInfo</td>
<td>array</td>
<td>诗歌的详细信息</td>
</tr>
<tr>
<td>enInfo</td>
<td>array</td>
<td>英语单词短语的详细信息</td>
</tr>
</tbody>
</table>
<p>汉字的基础信息,结构笔画等字段说明(zhBase):</p>
<table>
<thead>
<tr>
<th>参数</th>
<th>类型</th>
<th>说明</th>
</tr>
</thead>
<tbody>
<tr>
<td>strokeCount</td>
<td>Integer</td>
<td>笔画数</td>
</tr>
<tr>
<td>strokeNames</td>
<td>array</td>
<td>笔画列表</td>
</tr>
<tr>
<td>strokeFiles</td>
<td>array</td>
<td>笔顺发音文件,url</td>
</tr>
<tr>
<td>structure</td>
<td>Integer</td>
<td>结构:1左右结构,2左中右结构,3上下结构,4上中下结构,5单一结构,6独体结构,7品字结构,8嵌套结构,9镶嵌结构,10.半包围结构,11.全包围结构,12.上包围结构,13.上三包围结构,14.下包围结构,15.下三包围结构,16.右上包围结构,17.左包围结构,18.左三包围结构,19.左上包围结构,20.左下包围结构'</td>
</tr>
<tr>
<td>radical</td>
<td>string</td>
<td>偏旁</td>
</tr>
</tbody>
</table>
<p>汉字、词语、成语的详细信息字段说明(zhInfos):</p>
<table>
<thead>
<tr>
<th>参数</th>
<th>类型</th>
<th>说明</th>
</tr>
</thead>
<tbody>
<tr>
<td>id</td>
<td>Long</td>
<td>汉字、词语、成语的ID</td>
</tr>
<tr>
<td>spells</td>
<td>array</td>
<td>拼读文本</td>
</tr>
<tr>
<td>voices</td>
<td>array</td>
<td>-</td>
</tr>
<tr>
<td>spellFiles</td>
<td>array</td>
<td>汉字拼读发音文件</td>
</tr>
<tr>
<td>file</td>
<td>string</td>
<td>汉字词语成语发音文件</td>
</tr>
<tr>
<td>pinyin</td>
<td>string</td>
<td>拼音</td>
</tr>
<tr>
<td>meaning</td>
<td>string</td>
<td>释义</td>
</tr>
<tr>
<td>synonyms</td>
<td>array</td>
<td>近义词</td>
</tr>
<tr>
<td>antonyms</td>
<td>array</td>
<td>反义词</td>
</tr>
<tr>
<td>sentences</td>
<td>array</td>
<td>例句</td>
</tr>
<tr>
<td>words</td>
<td>array</td>
<td>组词</td>
</tr>
</tbody>
</table>
<p>诗歌的详细信息字段说明(poemInfo):</p>
<table>
<thead>
<tr>
<th>参数</th>
<th>类型</th>
<th>说明</th>
</tr>
</thead>
<tbody>
<tr>
<td>grade</td>
<td>String</td>
<td>年级</td>
</tr>
<tr>
<td>dynasty</td>
<td>String</td>
<td>朝代</td>
</tr>
<tr>
<td>poem</td>
<td>String</td>
<td>诗歌原文</td>
</tr>
<tr>
<td>ttsText</td>
<td>String</td>
<td>用来和成TTS字段</td>
</tr>
<tr>
<td>translation</td>
<td>string</td>
<td>翻译</td>
</tr>
<tr>
<td>explain</td>
<td>string</td>
<td>赏析</td>
</tr>
<tr>
<td>file</td>
<td>String</td>
<td>发音文件</td>
</tr>
<tr>
<td>- - author</td>
<td>array</td>
<td>作者信息</td>
</tr>
<tr>
<td>id</td>
<td>Long</td>
<td>ID</td>
</tr>
<tr>
<td>value</td>
<td>String</td>
<td>作者</td>
</tr>
<tr>
<td>memo</td>
<td>String</td>
<td>作者介绍</td>
</tr>
</tbody>
</table>
<p>英语单词短语的详细信息字段说明(enInfo):</p>
<table>
<thead>
<tr>
<th>参数</th>
<th>类型</th>
<th>说明</th>
</tr>
</thead>
<tbody>
<tr>
<td>spells</td>
<td>array</td>
<td>拼读文本</td>
</tr>
<tr>
<td>spellFiles</td>
<td>array</td>
<td>拼读发音文件</td>
</tr>
<tr>
<td>usFile</td>
<td>string</td>
<td>汉字词语成语发音文件</td>
</tr>
<tr>
<td>ukFile</td>
<td>String</td>
<td>汉字拼读发音文件</td>
</tr>
<tr>
<td>ukPhonetic</td>
<td>string</td>
<td>英式音标</td>
</tr>
<tr>
<td>usPhonetic</td>
<td>string</td>
<td>美式音标</td>
</tr>
<tr>
<td>usFileName</td>
<td>string</td>
<td>-</td>
</tr>
<tr>
<td>ukFileName</td>
<td>String</td>
<td>-</td>
</tr>
<tr>
<td>meanings</td>
<td>array</td>
<td>释义</td>
</tr>
<tr>
<td>- - phrases</td>
<td>array</td>
<td>单词的短语</td>
</tr>
<tr>
<td>word</td>
<td>string</td>
<td>原文</td>
</tr>
<tr>
<td>meaning</td>
<td>String</td>
<td>其对应的释义</td>
</tr>
<tr>
<td>- - sentences</td>
<td>array</td>
<td>例句</td>
</tr>
<tr>
<td>text</td>
<td>string</td>
<td>原文</td>
</tr>
<tr>
<td>translation</td>
<td>String</td>
<td>翻译</td>
</tr>
</tbody>
</table>
<h3>3. 获取字词数据方法</h3>
<pre><code class="language-java">public void getSearchWordInfo(String text)
public void getSearchWordInfo(String text, String pinyin)
</code></pre>
<h4>3.1 参数类型</h4>
<table>
<thead>
<tr>
<th>参数</th>
<th>是否必填</th>
<th>类型</th>
<th>说明</th>
</tr>
</thead>
<tbody>
<tr>
<td>text</td>
<td>是</td>
<td>String</td>
<td>字词文本</td>
</tr>
<tr>
<td>pinyin</td>
<td>否</td>
<td>string</td>
<td>有拼音中文会返回对应发音的释义,没有返回全部释义</td>
</tr>
</tbody>
</table>
<h3>4. 释放</h3>
<p><strong>接口名称:</strong></p>
<pre><code class="language-java">//注销
public void onExit();</code></pre>