account.h 文件参考

账户模块，提供账户激活/去激活/登录/登出等接口，并提供机器人账户详细信息的查询以及 HARIX 服务的域名信息查询。 更多...

类型定义
typedef void(*	AccountRequestCallBack) (void *context, bool success, int code, const char *error_message)
	Account通用回调函数指针，用于激活/登录/取消激活等状态回调。 更多...

函数
bool	HarixRcu_Account_IsActivated ()
	判断是否已经激活 更多...
void	HarixRcu_Account_DoActivate (void *context, const char *username, const char *password, const char *rcu_id, const char *robot_id, const char *activation_url, AccountRequestCallBack callback)
	用户名密码激活接口 更多...
void	HarixRcu_Account_RequestSmsVerificationCode (void *context, const char *phone_number, const char *activation_url, AccountRequestCallBack result_cb)
	获取短信激活验证码接口 更多...
void	HarixRcu_Account_DoSmsActivate (void *context, const char *phone_number, const char *sms_verifaction_code, const char *activation_url, AccountRequestCallBack result_cb)
	短信验证码激活接口 更多...
void	HarixRcu_Account_DoDeactivate ()
	取消激活接口，结果会通过HarixRcu_Account_SubscribeDeactivateCallback注册的回调函数返回 更多...
void	HarixRcu_Account_SubscribeDeactivateCallback (void *context, AccountRequestCallBack callback)
	注册取消激活结果的回调函数接口 更多...
void	HarixRcu_Account_UnsubscribeDeactivateCallback ()
	删除取消激活的回调函数 更多...
void	HarixRcu_Account_DoLogin (void *context, AccountRequestCallBack result_cb, const char *robot_id, const char *robot_type, const char *robot_model)
	登录接口 更多...
void	HarixRcu_Account_DoLogout ()
	登出接口.会断开roc/mmo/switch/smartvoice/smartvition等连接 更多...
const char *	HarixRcu_Account_GetRcuId ()
	获取Rcu Id 更多...
const char *	HarixRcu_Account_GetRobotId ()
	获取Robot Id 更多...
const char *	HarixRcu_Account_GetRobotType ()
	获取Robot类型 更多...
const char *	HarixRcu_Account_GetRobotModel ()
	获取Robot型号 更多...

详细描述

账户模块，提供账户激活/去激活/登录/登出等接口，并提供机器人账户详细信息的查询以及 HARIX 服务的域名信息查询。

激活和登录是设备访问 HARIX 的第一步。设备在登录前需要首先进行激活（若已激活则直接登录即可），HARIX 提供了两种激活模式:

1. 账号密码激活，需先联系 HARIX 管理员开设账户，该模式下可定制 AI 特性； 该模式下又分为预置 RobotId 激活 和 非预置 RobotId 激活；

   • 预置 RobotId 激活，激活前已获取 RobotId：
   • 非预置 RobotId 激活，激活前尚未获取 RobotId，需要在激活后才能获取（常见于 RCU 可插拔在任意机器人上的场景）：

1. 短信验证码激活，无需提前开户，该模式下为通用 AI 特性。如下流程：

类型定义说明

AccountRequestCallBack

typedef void(* AccountRequestCallBack) (void *context, bool success, int code, const char *error_message)

Account通用回调函数指针，用于激活/登录/取消激活等状态回调。

参数

context	上下文对象实例，用于调用者在回调函数中访问自己的对象
success	操作成功标识符
code	错误码
error_message	错误信息

函数说明

HarixRcu_Account_IsActivated()

bool HarixRcu_Account_IsActivated

(

)

判断是否已经激活

返回

返回值

true	已经激活成功
false	未激活

HarixRcu_Account_DoActivate()

void HarixRcu_Account_DoActivate	(	void *	context,
		const char *	username,
		const char *	password,
		const char *	rcu_id,
		const char *	robot_id,
		const char *	activation_url,
		AccountRequestCallBack	callback
	)

用户名密码激活接口

参数

context	上下文对象实例，用于调用者在回调函数中访问自己的对象
username	用户名
password	密码
rcu_id	Rcu Id
robot_id	Robot id，可以传“”，但是HarixRcu_Account_DoLogin时必须传入robot_id/robot_type/robot_model参数
activation_url	激活地址
result_cb	激活是否成功的回调函数

HarixRcu_Account_RequestSmsVerificationCode()

void HarixRcu_Account_RequestSmsVerificationCode	(	void *	context,
		const char *	phone_number,
		const char *	activation_url,
		AccountRequestCallBack	result_cb
	)

获取短信激活验证码接口

参数

context	上下文对象实例，用于调用者在回调函数中访问自己的对象
phone_number	电话号码
activation_url	激活地址
result_cb	验证码获取是否成功的回调函数

HarixRcu_Account_DoSmsActivate()

void HarixRcu_Account_DoSmsActivate	(	void *	context,
		const char *	phone_number,
		const char *	sms_verifaction_code,
		const char *	activation_url,
		AccountRequestCallBack	result_cb
	)

短信验证码激活接口

参数

context	上下文对象实例，用于调用者在回调函数中访问自己的对象
phone_number	电话号码
sms_verifaction_code	短信验证码
activation_url	激活地址
result_cb	短信激活是否成功的回调函数

HarixRcu_Account_DoDeactivate()

void HarixRcu_Account_DoDeactivate

(

)

取消激活接口，结果会通过HarixRcu_Account_SubscribeDeactivateCallback注册的回调函数返回

HarixRcu_Account_SubscribeDeactivateCallback()

void HarixRcu_Account_SubscribeDeactivateCallback	(	void *	context,
		AccountRequestCallBack	callback
	)

注册取消激活结果的回调函数接口

参数

context	上下文对象实例，用于调用者在回调函数中访问自己的对象
callback	取消激活的回调函数

HarixRcu_Account_UnsubscribeDeactivateCallback()

void HarixRcu_Account_UnsubscribeDeactivateCallback

(

)

删除取消激活的回调函数

HarixRcu_Account_DoLogin()

void HarixRcu_Account_DoLogin	(	void *	context,
		AccountRequestCallBack	result_cb,
		const char *	robot_id,
		const char *	robot_type,
		const char *	robot_model
	)

登录接口

参数

context	上下文对象实例，用于调用者在回调函数中访问自己的对象
result_cb	登录结果回调函数
robot_id	robot id，如果激活时传入的robot id为“”，则必须传入正确的值，其他情况可以传""
robot_type	robot type，如果激活时传入的robot id为“”，则必须传入正确的值，其他情况可以传""
robot_model	robot model，如果激活时传入的robot id为“”，则必须传入正确的值，其他情况可以传""

HarixRcu_Account_DoLogout()

void HarixRcu_Account_DoLogout

(

)

登出接口.会断开roc/mmo/switch/smartvoice/smartvition等连接

HarixRcu_Account_GetRcuId()

const char * HarixRcu_Account_GetRcuId

(

)

获取Rcu Id

返回

返回Rcu Id

HarixRcu_Account_GetRobotId()

const char * HarixRcu_Account_GetRobotId

(

)

获取Robot Id

返回

返回Robot Id

HarixRcu_Account_GetRobotType()

const char * HarixRcu_Account_GetRobotType

(

)

获取Robot类型

返回

返回Robot类型

HarixRcu_Account_GetRobotModel()

const char * HarixRcu_Account_GetRobotModel

(

)

获取Robot型号

返回

返回Robot型号