账号授权服务

sdkAuth

接口说明

sdk授权

接口定义

    int sdkAuth(AuthParam authParam)

参数描述

参数	类型	含义
authParam	AuthParam	SDK授权参数

AuthParam: SDK授权参数

public class AuthParam implements Serializable {
    /**
     * 应用程序对应的Client ID
     */
    private String clientId;
    /**
     * 应用程序对应的Client Secret
     */
    private String clientSecret;
}

返回值描述

类型	含义
int	错误码

---

setDispatcherHost

接口说明

设置服务器地址

接口定义

    void setDispatcherHost(String server)

参数描述

参数	类型	含义
server	String	服务器地址

返回值描述

无返回值

---

requestDispatcherHost

接口说明

查询服务器租户类型, 单租户 or 多租户

接口定义

    int requestDispatcherHost(CallBack<TenantMode, BizCodeModel> callBack)

参数描述

参数	类型	含义
callBack	CallBack	回调返回服务器租户类型

TenantMode: 服务器租户类型

public enum TenantMode {
    /**
     *  不生效
     */
    Invalid,
    /**
     * 单租户
     */
    Single,
    /**
     * 多租户
     */
    Multi
}

返回值描述

类型	含义
int	错误码

---

login

接口说明

普通登录

接口定义

    int login(LoginParam param)

参数描述

参数	类型	含义
param	LoginParam	登录参数

LoginParam: 登录参数

public class LoginParam implements Serializable {
    /**
     * 账号，账号字段不可为空
     */
    public String account;
    /**
     * 密码，密码字段不可为空
     */
    public String password;
    /**
     * 登录类型,默认登录PhoneNumber类型
     */
    public LoginType loginType = LoginType.PhoneNumber;
    /**
     * 自动登录字段
     */
    public boolean autoLogin = true;
}

返回值描述

类型	含义
int	错误码

---

loginByAuthCode

接口说明

鉴权码登录

接口定义

    void loginByAuthCode(String authCode, CallBack<Void, BizCodeModel> callBack)

参数描述

参数	类型	含义
authCode	String	鉴权码
callBack	CallBack	回调参数成功:onSuccess;失败:onFailure

返回值描述

无返回值

---

loginAppId

接口说明

appId登录

接口定义

    int loginAppId(AppIdLoginParamsEntity paramsEntity)

参数描述

参数	类型	含义
paramsEntity	AppIdLoginParamsEntity	appId登录参数

AppIdLoginParamsEntity: appId登录参数

public class AppIdLoginParamsEntity {
    // 必须，第三方用户身份，目前为手机号或邮箱
    private String identity;
    // 可选，身份类型，可选值: -1，（由第三方确定）
    private int identityType = -1;
    // 可选，企业号，多租户下必填，单租户模式下不用填（uc）
    private String partyId;
    // 可选，邮箱号，未传入时，则为空
    private String email;
    // 可选，手机号
    private String mobile;
    // 可选，手机区号，默认86
    private String mobileCode;
    // 可选，姓名
    private String name;
    // 可选，用户名，未传入时，则为空
    private String groupName;
    // 可选，账号，必须符合企业号码号段规则，未传入账号时，则系统自动分配
    private String mNumber;
    // 可选，性别，未传入时，默认为保密
    private int mGender;
}

返回值描述

类型	含义
int	错误码

---

ssoLogin

接口说明

sso登录

接口定义

    void ssoLogin(Map<String, String> urlMap, String thirdPartyDomain, CallBack<AccountGroup, BizCodeModel> callBack)

参数描述

参数	类型	含义
urlMap	Map<String,String>	sso登录参数
thirdPartyDomain	String	第三方地址
callBack	CallBack	回调参数成功：onSuccess；失败：onFailure

返回值描述

无返回值

---

thirdPartyLogin

接口说明

第三方登录

接口定义

    int thirdPartyLogin(LoginParam param)

参数描述

参数	类型	含义
param	LoginParam	第三方登录的登录参数

LoginParam: 第三方登录的登录参数

public class LoginParam implements Serializable {
    /**
     * 账号，账号字段不可为空
     */
    public String account;
    /**
     * 密码，密码字段不可为空
     */
    public String password;
    /**
     * 登录类型,默认登录PhoneNumber类型
     */
    public LoginType loginType = LoginType.PhoneNumber;
    /**
     * 自动登录字段
     */
    public boolean autoLogin = true;
}

返回值描述

类型	含义
int	错误码

---

requestThirdPartyInfo

接口说明

查询企业信息，多租户服务器下使用

接口定义

    int requestThirdPartyInfo(String number, CallBack<ThirdPartyInfoModel, BizCodeModel> callBack)

参数描述

参数	类型	含义
number	String	企业号
callBack	CallBack	返回企业信息

返回值描述

类型	含义
int	错误码

---

logOut

接口说明

登出

接口定义

    int logOut()

参数描述

无参数

返回值描述

类型	含义
int	错误码

---

getAccountInfo

接口说明

获取登录的账号信息

接口定义

    AccountInfo getAccountInfo()

参数描述

无参数

返回值描述

类型	含义
AccountInfo	账号信息

AccountInfo: 账号信息

public class AccountInfo implements Serializable {
    /**
     *  账号uuid，和联系人模块关联
     */
    private String id;
    /**
     *  账号短号
     */
    private String number;
    /**
     *  账号长号，格式为企业号+账号短号
     */
    private String fullNumber;
    /**
     *  账号所在企业号
     */
    private String partyNumber;
    /**
     *  账号名字
     */
    private String name;
    /**
     *  账号手机号
     */
    private String phoneNumber;
    /**
     *  账号邮箱
     */
    private String emailAddress;
    /**
     *  账号性别
     */
    private UserGender userGender;
    /**
     *  账号所在企业名字
     */
    private String partyName;
    /**
     *  账号所在域
     */
    private String partyDomain;
    /**
     *  账号所在域的时区ID，用于预约会议默认时区
     */
    private String partyZoneID;
    /**
     *  是否支持即时会议
     */
    private boolean supportMeetingNow;
}

---

getLoginStatus

接口说明

获取登录状态

接口定义

    LoginStatus getLoginStatus()

参数描述

无参数

返回值描述

类型	含义
LoginStatus	当前的登录状态

LoginStatus: 当前的登录状态

public enum LoginStatus {
    /**
     * 默认状态
     */
    UNKNOWN,
    /**
     * 登录中
     */
    REGING,
    /**
     * 已登录
     */
    REGED,
    /**
     * 登录失败
     */
    REG_FAILED
}

---

addAccountCallBack

接口说明

添加登录监听

接口定义

    void addAccountCallBack(IAuthListener pCallBack)

参数描述

参数	类型	含义
pCallBack	IAuthListener	登录监听

返回值描述

无返回值

---

removeAccountCallBack

接口说明

移除登录监听，避免内存泄漏

接口定义

    void removeAccountCallBack(IAuthListener pCallBack)

参数描述

参数	类型	含义
pCallBack	IAuthListener	登录监听

返回值描述

无返回值

---