package com.iailab.module.system.service.social;
|
|
import com.iailab.framework.common.exception.ServiceException;
|
import com.iailab.framework.common.pojo.PageResult;
|
import com.iailab.module.system.api.social.dto.SocialUserBindReqDTO;
|
import com.iailab.module.system.api.social.dto.SocialUserRespDTO;
|
import com.iailab.module.system.controller.admin.socail.vo.user.SocialUserPageReqVO;
|
import com.iailab.module.system.dal.dataobject.social.SocialUserDO;
|
import com.iailab.module.system.enums.social.SocialTypeEnum;
|
|
import javax.validation.Valid;
|
import java.util.List;
|
|
/**
|
* 社交用户 Service 接口,例如说社交平台的授权登录
|
*
|
* @author iailab
|
*/
|
public interface SocialUserService {
|
|
/**
|
* 获得指定用户的社交用户列表
|
*
|
* @param userId 用户编号
|
* @param userType 用户类型
|
* @return 社交用户列表
|
*/
|
List<SocialUserDO> getSocialUserList(Long userId, Integer userType);
|
|
/**
|
* 绑定社交用户
|
*
|
* @param reqDTO 绑定信息
|
* @return 社交用户 openid
|
*/
|
String bindSocialUser(@Valid SocialUserBindReqDTO reqDTO);
|
|
/**
|
* 取消绑定社交用户
|
*
|
* @param userId 用户编号
|
* @param userType 全局用户类型
|
* @param socialType 社交平台的类型 {@link SocialTypeEnum}
|
* @param openid 社交平台的 openid
|
*/
|
void unbindSocialUser(Long userId, Integer userType, Integer socialType, String openid);
|
|
/**
|
* 获得社交用户,基于 userId
|
*
|
* @param userType 用户类型
|
* @param userId 用户编号
|
* @param socialType 社交平台的类型
|
* @return 社交用户
|
*/
|
SocialUserRespDTO getSocialUserByUserId(Integer userType, Long userId, Integer socialType);
|
|
/**
|
* 获得社交用户
|
*
|
* 在认证信息不正确的情况下,也会抛出 {@link ServiceException} 业务异常
|
*
|
* @param userType 用户类型
|
* @param socialType 社交平台的类型
|
* @param code 授权码
|
* @param state state
|
* @return 社交用户
|
*/
|
SocialUserRespDTO getSocialUserByCode(Integer userType, Integer socialType, String code, String state);
|
|
// ==================== 社交用户 CRUD ====================
|
|
/**
|
* 获得社交用户
|
*
|
* @param id 编号
|
* @return 社交用户
|
*/
|
SocialUserDO getSocialUser(Long id);
|
|
/**
|
* 获得社交用户分页
|
*
|
* @param pageReqVO 分页查询
|
* @return 社交用户分页
|
*/
|
PageResult<SocialUserDO> getSocialUserPage(SocialUserPageReqVO pageReqVO);
|
|
}
|