版本支持: v1.0.0+
接口概述: 三方账号登录（v3.3.4废弃，请使用三方账号登录2.0代替）
接口定义
- (void)loginExternalAccount:(NSString * _Nonnull)extUserId userName:(NSString * _Nullable)userName enterpriseId:(NSString *)enterpriseId;
接口参数:
参数名 | 类型 | 是否必填 | 默认值 | 描述 |
extUserId | NSString* | 是 | 无 | 用户唯一id，最大50个字符，支持大小写英文字母、数字、上横线“-”、下横线“_” |
userName | NSString* | 是 | 无 | 外部用户名 |
enterpriseId | NSString* | 是 | 无 | 企业ID |
返回值: 无
版本支持: v1.0.0+
接口概述: 小鱼账号登录（v3.3.4废弃，请使用小鱼账号登录2.0代替）
接口定义
- (void)loginXYLinkAccount:(NSString *)userName password:(NSString *)password;
接口参数:
参数名 | 类型 | 是否必填 | 默认值 | 描述 |
userName | NSString* | 是 | 无 | 小鱼系统用户账号 |
password | NSString* | 是 | 无 | 小鱼系统用户密码 |
返回值: 无
版本支持: v1.0.0+
接口概述: 三方授权登录（v3.3.4废弃，请使用三方授权登录2.0代替）
接口定义
- (void)loginExternalAccountByToken:(NSString *)account token:(NSString *)token;
接口参数:
参数名 | 类型 | 是否必填 | 默认值 | 描述 |
account | NSString* | 是 | 无 | 账户 |
token | NSString* | 是 | 无 | token(需要自己获取) |
返回值: 无
版本支持: v1.0.0+
接口概述: 企业免密登录
接口定义
- (void)loginEnterpriseAccount:(NSString*)account;
接口参数:
参数名 | 类型 | 是否必填 | 默认值 | 描述 |
account | NSString* | 是 | 无 | 账号 |
返回值: 无
版本支持: v3.3.4+
接口概述: 小鱼账号登录2.0
接口定义
- (void)loginXYAccount:(NSString *)account password:(NSString *)password countryCode:(NSString *_Nullable)countryCode;
接口参数:
参数名 | 类型 | 是否必填 | 默认值 | 描述 |
account | NSString* | 是 | 无 | 账号 |
password | NSString* | 是 | 无 | 密码 |
countryCode | NSString* | 是 | 无 | 国家码 |
返回值: 无
版本支持: v3.3.4+
接口概述: 三方账号登录2.0
接口定义
- (void)loginExtUserId:(NSString *)extUserId authCode:(NSString *)authCode displayName:(NSString *)displayName;
接口参数:
参数名 | 类型 | 是否必填 | 默认值 | 描述 |
extUserId | NSString* | 是 | 无 | 用户唯一id，最大50个字符，支持大小写英文字母、数字、上横线“-”、下横线“_” |
authCode | NSString* | 是 | 无 | 认证授权码 |
displayName | NSString* | 是 | 无 | 用户名称 |
返回值: 无
版本支持: v3.3.4+
接口概述: 三方授权登录2.0
接口定义
- (void)loginExtToken:(NSString *)token;
接口参数:
参数名 | 类型 | 是否必填 | 默认值 | 描述 |
token | NSString* | 是 | 无 | 认证token |
返回值: 无
版本支持: v3.3.4+
接口概述: 单点登录
接口定义
- (void)loginXYAccountWithToken:(NSString *)token;
接口参数:
参数名 | 类型 | 是否必填 | 默认值 | 描述 |
token | NSString* | 是 | 无 | 认证token |
返回值: 无
版本支持: v2.29.6+
接口概述: 刷新access_token
接口定义
- (void)refreshToken:(NSString *)refreshToken completion:(void(^)(XYUser *user))completion;
接口参数:
参数名 | 类型 | 是否必填 | 默认值 | 描述 |
refreshToken | NSString* | 是 | 无 | refreshToken从登录成功回调中返回 |
completion | block | 是 | 无 | 回调，刷新后的数据保存在user中 |
返回值: 无
版本支持: v1.0.0+
接口概述: 退出登录
接口定义
- (void)logout;
接口参数: 无
返回值: 无
版本支持: v1.0.0+
接口概述: 登录状态
接口定义
- (BOOL)isLogon;
接口参数: 无
返回值:
返回值名 | 类型 | 描述 |
result | BOOL | 登录状态 |
版本支持: v1.0.0+
接口概述: WS连接状态
接口定义
- (BOOL)isWSConnected;
接口参数: 无
返回值:
返回值名 | 类型 | 描述 |
result | BOOL | WS连接状态 |