程序包 com.getui.push.v2.sdk.api

接口 UserApi

public interface UserApi

create by getui on 2020/6/4

作者:

getui

方法概要

修饰符和类型	方法	说明
ApiResult<Void>	addBlackUser(Set<String> cidSet)	添加黑名单用户
ApiResult<Void>	batchUnbindAlias(CidAliasListDTO cidAliasListDTO)	批量解绑别名
ApiResult<Void>	bindAlias(CidAliasListDTO cidAliasListDTO)	绑定别名
ApiResult<Map<String,String>>	deleteUsersTag(String customerTag, UserDTO userDTO)	删除标签
ApiResult<AliasResDTO>	queryAliasByCid(String cid)	根据cid查询别名
ApiResult<AliasResDTO>	queryAliasByCid(String cid, String aliasType)	根据cid查询指定别名类型下的别名
ApiResult<QueryCidResDTO>	queryCidByAlias(String alias)	根据别名查询cid
ApiResult<QueryCidResDTO>	queryCidByAlias(String alias, String aliasType)	根据别名类型与别名查询cid
ApiResult<Map<String,Integer>>	queryUser(ConditionListDTO conditionListDTO)	查询符合条件的用户总量
ApiResult<Map<String,CidStatusDTO>>	queryUserStatus(Set<String> cidSet)	查询用户状态
ApiResult<Map<String,List<String>>>	queryUserTags(String cid)	查询用户标签
ApiResult<Void>	removeBlackUser(Set<String> cidSet)	移除黑名单用户
ApiResult<Void>	setBadge(Set<String> cidSet, BadgeDTO badgeDTO)	设置角标
ApiResult<Void>	unbindAllAlias(String alias)	解绑所有别名
ApiResult<Void>	unbindAllAlias(String alias, String aliasType)	解绑指定别名类型下的别名
ApiResult<Void>	userBindTags(String cid, TagDTO tagDTO)	一个用户绑定一批标签
ApiResult<Map<String,String>>	usersBindTag(String customerTag, UserDTO userDTO)	一批用户绑定一个标签

方法详细资料

bindAlias

ApiResult<Void> bindAlias(CidAliasListDTO cidAliasListDTO)

绑定别名

参数:

cidAliasListDTO -

返回:

queryAliasByCid

ApiResult<AliasResDTO> queryAliasByCid(String cid)

根据cid查询别名

参数:

cid -

返回:

queryAliasByCid

ApiResult<AliasResDTO> queryAliasByCid(String cid,
                                       String aliasType)

根据cid查询指定别名类型下的别名

参数:

cid -

aliasType - 别名类型

返回:

queryCidByAlias

ApiResult<QueryCidResDTO> queryCidByAlias(String alias)

根据别名查询cid

参数:

alias -

返回:

queryCidByAlias

ApiResult<QueryCidResDTO> queryCidByAlias(String alias,
                                          String aliasType)

根据别名类型与别名查询cid

参数:

alias -

aliasType -

返回:

batchUnbindAlias

ApiResult<Void> batchUnbindAlias(CidAliasListDTO cidAliasListDTO)

批量解绑别名

参数:

cidAliasListDTO -

返回:

unbindAllAlias

ApiResult<Void> unbindAllAlias(String alias)

解绑所有别名

参数:

alias - 别名

返回:

userBindTags

ApiResult<Void> userBindTags(String cid,
                             TagDTO tagDTO)

一个用户绑定一批标签

参数:

cid -

tagDTO -

返回:

unbindAllAlias

ApiResult<Void> unbindAllAlias(String alias,
                               String aliasType)

解绑指定别名类型下的别名

参数:

alias -

aliasType -

返回:

usersBindTag

ApiResult<Map<String,String>> usersBindTag(String customerTag,
                                                 UserDTO userDTO)

一批用户绑定一个标签

参数:

customerTag - 标签

userDTO -

返回:

deleteUsersTag

ApiResult<Map<String,String>> deleteUsersTag(String customerTag,
                                                   UserDTO userDTO)

删除标签

参数:

customerTag - 标签

userDTO -

返回:

ApiResult.getData() map, k: cid; v: 删除状态

queryUserTags

ApiResult<Map<String,List<String>>> queryUserTags(String cid)

查询用户标签

参数:

cid -

返回:

addBlackUser

ApiResult<Void> addBlackUser(Set<String> cidSet)

添加黑名单用户

参数:

cidSet -

返回:

removeBlackUser

ApiResult<Void> removeBlackUser(Set<String> cidSet)

移除黑名单用户

参数:

cidSet -

返回:

queryUserStatus

ApiResult<Map<String,CidStatusDTO>> queryUserStatus(Set<String> cidSet)

查询用户状态

参数:

cidSet -

返回:

setBadge

ApiResult<Void> setBadge(Set<String> cidSet,
                         BadgeDTO badgeDTO)

设置角标

参数:

cidSet -

badgeDTO -

返回:

queryUser

ApiResult<Map<String,Integer>> queryUser(ConditionListDTO conditionListDTO)

查询符合条件的用户总量

参数:

conditionListDTO - 查询条件

返回: