接口参考_湖南轩利_为用户提供一站式的云服务及音视频整体解决方案

入门使用

通讯录

更新时间：2019-11-20

接口名称	接口描述
tsdk_set_system_icon	设置系统头像。
tsdk_set_user_def_icon	设置自定义头像。
tsdk_get_user_icon	搜索联系人头像。
tsdk_search_contacts	搜索联系人。

tsdk_set_system_icon

接口描述

设置系统头像。

注意事项

无。

方法定义

TSDK_API TSDK_RESULT tsdk_set_system_icon(IN TSDK_UINT32 icon_id);

									 

参数描述

参数名	是否必须	类型	描述
[in] icon_id	是	TSDK_UINT32	系统头像序号。

返回值

类型	描述
TSDK_RESULT	成功返回TSDK_SUCCESS，失败返回相应错误码。

代码示例

TSDK_RESULT ret;
ret = tsdk_set_system_icon(iconId);
if (TSDK_SUCCESS != ret)
{
    LOG_D_CALL_ERROR("set system icon failed. result=%#x", ret);
    return -1;
}
return TSDK_SUCCESS;

									 

tsdk_set_user_def_icon

接口描述

设置自定义头像。

注意事项

设置自定义头像需注意：自定义头像信息里需要设置头像的内容以及内容的长度，并且头像需要选择为小头像52*52、中头像120*120和大头像320*320三种其中具体大小应根据服务器要求来定。
图片的格式不支持TIFF格式，推荐使用png格式。
图片的大小服务器没有限制，产品可以根据实际的需要进行限制，建议图片大小最大值为2MB。

方法定义

TSDK_API TSDK_RESULT tsdk_set_user_def_icon(IN TSDK_S_ICON_INFO* icon_info,  OUT TSDK_CHAR *update_time, IO TSDK_UINT32 *lenght);

									 

参数描述

参数	是否必须	类型	描述
[in] icon_info	是	TSDK_S_ICON_INFO*	自定义头像信息。
[out] update_time	是	TSDK_CHAR*	头像更改时间，空间由上层适配提供。
[io] length	是	TSDK_UINT32*	头像更新时间长度，传入时为空间大小，传出时为实际字串长度。

返回值

类型	描述
TSDK_RESULT	成功返回TSDK_SUCCESS，失败返回相应错误码。

代码示例

TSDK_RESULT ret;ret = tsdk_set_user_def_icon(iconInfo,updateTime,length);
if (TSDK_SUCCESS != ret)
{
    LOG_D_CALL_ERROR("set user def icon failed. result=%#x", ret);
    return -1;
}
return TSDK_SUCCESS;

									 

tsdk_get_user_icon

接口描述

获取联系人头像。

注意事项

无。

方法定义

TSDK_API TSDK_RESULT tsdk_get_user_icon(IN TSDK_S_GET_ICON_PARAM *icon_param);

									 

参数描述

参数名	是否必须	类型	描述
[in] icon_param	是	TSDK_S_GET_ICON_PARAM*	获取头像请求参数。

返回值

类型	描述
TSDK_RESULT	成功返回TSDK_SUCCESS，失败返回相应错误码。

代码示例

TSDK_RESULT ret;
ret = tsdk_get_user_icon(iconParam);
if (TSDK_SUCCESS != ret)
{
    LOG_D_CALL_ERROR("get user icon failed. result=%#x", ret);
    return -1;
}
return TSDK_SUCCESS;

									 

tsdk_search_contacts

接口描述

搜索联系人。

注意事项

无。

方法定义

TSDK_API TSDK_RESULT tsdk_search_contacts(IN const TSDK_S_SEARCH_CONTACTS_PARAM* search_param);

									 

参数描述

参数名	是否必须	类型	描述
[in] search_param	是	const TSDK_S_SEARCH_CONTACTS_PARAM*	搜索联系人请求参数。

返回值

类型	描述
TSDK_RESULT	成功返回TSDK_SUCCESS，失败返回相应错误码。

代码示例

								TSDK_RESULT ret;
ret = tsdk_search_contacts(searchParam);
if (TSDK_SUCCESS != ret)
{
    LOG_D_CALL_ERROR("search contacts failed. result=%#x", ret);
    return -1;
}
return TSDK_SUCCESS;
							