企业🤖AI智能体构建引擎,智能编排和调试,一键部署,支持私有化部署方案 广告
### **可选函数:** **设置服务器认证密码** `+ (int) SetServerAuthPass: (NSString*) lpPassword` 功能:设置服务器连接认证密码,确保SDK能正常连接到服务器。 返回值:0表示成功,否则为出错代码 参数: lpPassword 认证密码(大小写敏感); 备注: 为了防止未授权SDK连接服务器,在服务器配置文件(AnyChatCoreServer.ini)中可设置“SDKAuthPass”,如果该配置项被设置,当SDK连接服务器时,会将该方法所传入的密码加密后传输到服务器,服务器再比较是否合法,如果密码不正确,则连接将被断开。如果该配置项未被设置(配置文件默认),则无论该方法是否被调用,SDK均可正常连接到服务器。 ### **必选函数:** **连接服务器** `+ (int) Connect: (NSString*) lpServerAddr : (int) dwPort` 功能:用于与服务器建立连接。 返回值:0表示成功,否则为出错代码 参数: lpServerAddr 服务器IP地址,或是网站域名(URL)地址; dwPort 服务端口号(默认为8906) 备注: 返回值为0并不表示连接服务器成功,仅表示SDK已成功收到连接服务器的指令,如果连接成功,或是失败,都将会通过相应的接口通知上层应用,这里是一个异步的过程。 * * * * * **登录系统** `+ (int) Login: (NSString*) lpUserName : (NSString*) lpPassword` 功能:登录服务器,请求身份认证。 返回值:0表示成功,否则为出错代码 参数: lpUserName 注册用户名; lpPassword 登录密码(为空表示游客); 备注: 该方法可以连接系统之后立即调用,而不用关心连接系统是否成功,当SDK连接系统成功之后,如果之前调用过该方法,则SDK将会自动向服务器发出登录系统的申请。 返回值为0并不表示登录服务器成功,仅表示SDK已成功收到登录服务器的指令,如果登录成功,或是失败,都将会通过相应的接口通知上层应用,这里是一个异步的过程。 如果服务器配置了“SDK Filter Plus”插件,则客户端调用该方法后,将会触发其API接口:BRFP_VerifyUser,用户名、密码参数将会作为参数传递给该API函数,由“SDK Filter Plus”完成用户的身份验证工作,服务器根据该API接口的返回值来判定是否通过身份验证,详细信息可参考文档《AnyChat SDK Filter Plus开发指南》。 如果在服务器端使用“AnyChat Server SDK”开发了业务层服务器,则客户端调用该方法后,将会触发业务层服务器的回调函数“BRAS_VerifyUser_CallBack”,由业务层服务器完成用户的身份验证工作,服务器根据回调函数的返回值来判定是否通过身份验证,详细信息可参考文档《AnyChat Server SDK 开发指南》。 `+ (int) LoginEx: (NSString*) lpNickName : (int) dwUserId : (NSString*) lpStrUserId : (NSString*) lpAppId : (int) dwTimeStamp: (NSString*) lpSigStr : (NSString*) lpStrParam;` 功能: 登录扩展接口,支持用户身份验证签名后进行登录。 参数: lpNickName 字符串值,用户显示名称 dwUserId 整形值,用户Id值,如果应用没有此参数,则传入-1 lpStrUserId 字符串值,用户编号,如果dwUserId参数有值,则此参数值可为传空字符串;如果dwUserId为-1,则需要传此参数值 lpStrAppId 字符串值,在集群版本、视频云平台申请的应用Id dwTimeStamp 整形值,签名的时间戳,由签名工具返回 lpSigStr 字符串值,使用应用的公钥和私钥进行签名后生成的签名字符串 lpStrParam 字符串值,预留参数,传空字符串 返回值:0表示成功,否则为出错代码; 说明: 此接口用于用户在自有的或第三方的身份验证系统验证后,根据获取的应用公钥和设置的私钥数据,再调用AnyChat提供的或自己编写的身份签名工具对用户进行身份签名。签名后再调用此接口进行登录;通过该接口后则不需要再由AnyChat业务服务器进行身份验证了。 如果在系统或应用中设置了允许用户以游客的身份进行登录,则该接口也可以不用验证用户身份签名,允许用户登录系统