智慧服务,成就美好体验 项目咨询

主页 > 服务与支持 > 开发平台 > 客户端SDK参考 > iOS Native SDK > 接口参考 组件初始化和配置

入门使用

组件初始化和配置

更新时间:2019-11-20

接口名称

接口描述

tsdk_set_config_param

设置业务参数。

tsdk_init

初始化组件。

tsdk_uninit

去初始化。

tsdk_release_sdk_mem

释放TSDK内存。

tsdk_set_config_param

接口描述

设置业务参数。

注意事项

无。

方法定义

TSDK_API TSDK_RESULT tsdk_set_config_param(IN TSDK_E_CONFIG_ID config_id, IN TSDK_VOID *param);
 

参数描述

参数

是否必须

类型

描述

[in] config_id

TSDK_E_CONFIG_ID

参数配置ID。

[in] param

TSDK_VOID *

参数值,根据配置的ID确定数据类型。

返回值

类型

描述

TSDK_RESULT

成功返回TSDK_SUCCESS,失败返回相应错误码。

代码示例

//OC
TSDK_S_LOG_PARAM logParam;
memset(&logParam, 0, sizeof(TSDK_S_LOG_PARAM));
NSString *path = [logPath stringByAppendingString:@"/tsdk"];
logParam.level = TSDK_E_LOG_DEBUG;
logParam.file_count = 1;
logParam.max_size_kb = 4*1024;
strcpy(logParam.path, [path UTF8String]);
TSDK_RESULT configResult = tsdk_set_config_param(TSDK_E_CONFIG_LOG_PARAM, &logParam);
DDLogInfo(@"config log param result: %d",configResult);

TSDK_S_APP_FILE_PATH_INFO app_file_path;
memset(&app_file_path, 0, sizeof(TSDK_S_APP_FILE_PATH_INFO));
NSString *iconPath = [[NSHomeDirectory() stringByAppendingPathComponent:@"Documents"] stringByAppendingString:@"/TUPC60log/tsdk/icon"];
NSString *deptFilePath = [[NSHomeDirectory() stringByAppendingPathComponent:@"Documents"] stringByAppendingString:@"/TUPC60log/tsdk/deptFile"];
strcpy(app_file_path.icon_file_path, [iconPath UTF8String]);
strcpy(app_file_path.dept_file_path, [deptFilePath UTF8String]);
configResult = tsdk_set_config_param(TSDK_E_CONFIG_APP_FILE_PATH_INFO, &app_file_path);
DDLogInfo(@"config app file path info result: %d", configResult);
 

tsdk_init

接口描述

初始化终端SDK组件。

注意事项

无。

方法定义

TSDK_API TSDK_RESULT tsdk_init(IN TSDK_S_APP_INFO_PARAM *app_info, IN TSDK_FN_CALLBACK_PTR notify);
 

参数描述

参数

是否必须

类型

描述

[in] app_info

TSDK_S_APP_INFO_PARAM*

应用程序信息参数。

[in] notify

TSDK_FN_CALLBACK_PTR

事件通知回调函数地址。

返回值

类型

描述

TSDK_RESULT

成功返回TSDK_SUCCESS,失败返回相应错误码。

代码示例

//OC
TSDK_S_APP_INFO_PARAM app_info;
app_info.client_type = TSDK_E_CLIENT_MOBILE;
strcpy(app_info.product_name, "SoftClient on Mobile");
app_info.support_audio_and_video_call = TSDK_TRUE;
app_info.support_ctd = TSDK_TRUE;
app_info.support_audio_and_video_conf = TSDK_TRUE;
app_info.support_enterprise_address_book = TSDK_TRUE;
//    app_info.support_im = TSDK_TRUE;
//    app_info.support_data_conf = TSDK_TRUE;
//    app_info.support_rich_media_message = TSDK_TRUE;
TSDK_RESULT result = tsdk_init(&app_info ,&onTSDKNotifications);
 

tsdk_uninit

接口描述

去初始化终端SDK组件。

注意事项

程序退出前请调用,调用前停止相关业务。

方法定义

TSDK_API TSDK_RESULT tsdk_uninit(TSDK_VOID);
 

参数描述

无。

返回值

类型

描述

TSDK_RESULT

成功返回TSDK_SUCCESS,失败返回相应错误码。

代码示例

//OC
-(BOOL)unInitLoginServer
{
    TSDK_RESULT result = tsdk_uninit();
    
    DDLogInfo(@"Login_Log: tsdk_uninit result = %#x",result);
    return result == TSDK_SUCCESS ? YES : NO;
}
 

tsdk_release_sdk_mem

接口描述

释放SDK内部分配的内存。

注意事项

仅用于释放TSDK 组件接口或回调通知中返回的内存。

方法定义

TSDK_VOID tsdk_release_sdk_mem(IN TSDK_VOID* memory_ptr);
 

参数描述

参数

是否必须

类型

描述

[in] memory_ptr

TSDK_VOID *

待释放的内存资源地址。

返回值

无。

代码示例

无。