cn.jpush.im.android.api.model
类 GroupInfo
- java.lang.Object
- cn.jpush.im.android.api.model.GroupBasicInfo
- cn.jpush.im.android.api.model.GroupInfo
public abstract class GroupInfo extends GroupBasicInfo
嵌套类概要
-
从类继承的嵌套类/接口 cn.jpush.im.android.api.model.GroupBasicInfo
GroupBasicInfo.Type
构造器概要
构造器 构造器和说明 GroupInfo()
方法概要
所有方法 静态方法;) 实例方法;) 抽象方法;) 具体方法;) 已过时的方法;) 限定符和类型 方法和说明 abstract void
addGroupBlacklist(java.util.List
将用户加到群组黑名单,只有群主和管理员有此权限, 被加入黑名单的用户如果在群内会被踢出群组,黑名单中的用户无法再加入群组
操作成功后群内成员将收到群黑名单变更事件GroupBlackListChangedEvent
abstract void
addGroupKeeper(java.util.List
添加群管理员,管理员可以移除、禁言普通群成员,并且在公开群组里可以直接添加群成员和审核入群审批GroupApprovalEvent
.
abstract void
addGroupSilenceWithTime(java.util.Collection
设置群成员禁言(可设置禁言时间,批量设置一次最多500个),群主和管理员可以禁言普通群成员, 群主和管理员不能被禁言,重复调用此接口将根据当前时间重新计算结束时间。
abstract void
changeGroupAdmin(java.lang.String username,
java.lang.String appKey,
BasicCallback callback)
移交群主,将群主移交給指定群内成员,移交群主后原群主成为普通群成员.
abstract void
changeGroupType(GroupBasicInfo.Type type,
BasicCallback callback)
修改群组类型,群组类型修改成功后群内所有成员会收到群类型变更事件,SDK会以类型为EventNotificationContent.EventNotificationType.group_type_changed
的消息事件方式上报,注意只有群主有权限修改群组类型,并且如果修改后的群组类型未发生改变的话不会有事件上报
abstract void
delGroupAnnouncement(int announceID,
BasicCallback callback)
删除群内指定id的公告,只有群主和管理员有权限删除
删除群公告成功时群内所有成员会收到GroupAnnouncementChangedEvent
abstract void
delGroupBlacklist(java.util.List
将用户从群组黑名单中移除,只有群主和管理员有此权限.
abstract void
delGroupSilence(java.util.Collection
取消群成员禁言(批量设置一次最多500个),取消禁言成功后会以系统消息形式通知群内成员
static GroupInfo
fromJson(java.lang.String jsonString)
从Json字符串转换成对象, 转换失败返回null
static java.util.Collection
fromJsonToGroupCollection(java.lang.String jsonString)
从Json字符串转换成Collection对象,方便GroupInfo的集合类的转换, 转换失败返回null
abstract void
getAnnouncementsByOrder(RequestCallback
按照顺序(置顶时间倒序,创建时间倒序)获取群内所有公告.
abstract void
getAvatarBitmap(GetAvatarBitmapCallback callback)
从本地获取群组头像的缩略图bitmap,如果本地存在头像缩略图文件,直接返回;若不存在,会异步从服务器拉取。
abstract java.io.File
getAvatarFile()
从本地获取群头像缩略图文件,头像缩略图会在调用JMessageClient.getGroupInfo(long, GetGroupInfoCallback)
时自动下载。
abstract void
getBigAvatarBitmap(GetAvatarBitmapCallback callback)
从本地获取群组头像的原图bitmap,如果本地存在头像原图文件,直接返回;若不存在,会异步从服务器拉取。
abstract java.io.File
getBigAvatarFile()
从本地获取群组头像原图文件,当群组未设置头像,或者本地不存在头像原图文件时此接口返回Null。
abstract void
getGroupBlackList(RequestCallback
获取群组的黑名单用户列表, 按照被拉黑时间倒序排列
abstract java.util.List
getGroupKeeperMemberInfos()
获取群管理员列表, 返回群内管理员的成员GroupMemberInfo
列表
abstract java.util.List
getGroupKeepers()
已过时。
deprecated in jmessage 2.7.0 usegetGroupKeeperMemberInfos()
instead
<code>abstract GroupMemberInfo</code> <code>getGroupMember(java.lang.String username,
java.lang.String appKey)</code>
根据appKey跨应用获取单个群成员GroupMemberInfo
abstract UserInfo
getGroupMemberInfo(java.lang.String username)
已过时。
deprecated in jmessage 1.3.0 use getGroupMemberInfo(String, String)
instead.
<code>abstract UserInfo</code> <code>getGroupMemberInfo(java.lang.String username,
java.lang.String appKey)</code>
已过时。
deprecated in jmessage 2.7.0 usergetGroupMember(String, String)
instead
<code>abstract java.util.List<groupmemberinfo></groupmemberinfo></code> <code>getGroupMemberInfos()</code>
获取群成员GroupMemberInfo
列表
abstract java.util.List
getGroupMembers()
已过时。
deprecated in 2.7.0, usegetGroupMemberInfos()
<code>abstract void</code> <code>getGroupMemberSilence(java.lang.String name,
java.lang.String appkey,
RequestCallback<silenceinfo> callback)</silenceinfo></code>
查询用户在群内的禁言状态,如果用户未处于禁言状态,回调中SilenceInfo为null
abstract java.lang.String
getGroupOwner()
已过时。
in 2.7.0 usegetOwnerMemberInfo()
instead
<code>abstract void</code> <code>getGroupSilenceList(RequestCallback<java.util.list<silenceinfo>> callback)</java.util.list<silenceinfo></code>
获取群禁言列表,排序规则以添加入禁言的先后的时间倒序排序(后加入的在前)
abstract java.util.List
getGroupSilenceMemberInfos()
已过时。
deprecated in jmessage 2.8.2 use getGroupSilenceList(RequestCallback)
instead
<code>abstract java.util.List<userinfo></userinfo></code> <code>getGroupSilenceMembers()</code>
已过时。
deprecated in jmessage 2.7.0 use getGroupSilenceList(RequestCallback)
()} instead
<code>abstract int</code> <code>getNoDisturb()</code>
群组是否在免打扰名单中
abstract java.lang.String
getOwnerAppkey()
已过时。
in 2.7.0 usegetOwnerMemberInfo()
instead
<code>abstract GroupMemberInfo</code> <code>getOwnerMemberInfo()</code>
获取群主的群内信息GroupMemberInfo
static java.lang.String
groupCollectionToJson(java.util.Collection
将GroupInfo对象的集合类转换为Json字符串,使用fromJsonToGroupCollection(String)
转换回来
abstract int
isGroupBlocked()
群组是否在被屏蔽的名单中
abstract boolean
isKeepSilence(java.lang.String username,
java.lang.String appKey)
已过时。
deprecated in jmessage 2.8.2 use getGroupMemberSilence(String, String, RequestCallback)
<code>abstract void</code> <code>publishGroupAnnouncement(java.lang.String text,
java.lang.Boolean needSendMessage,
PublishAnnouncementCallback callback)</code>
发布群公告(只有群主和管理员有权限发送),选择是否向群中发布消息,sendMessage为true代表发送,false不发送
注意只有发送公告成功时才会向群中发布消息,创建的消息在回调中返回,如果发送公告失败或者创建消息失败则回调中message为null。
abstract void
removeGroupKeeper(java.util.List
取消群管理员,管理员角色描述详见官方文档群组管理员
abstract void
setBlockGroupMessage(int blocked,
BasicCallback callback)
设置屏蔽群消息,设置后将不会再收到此群的消息
abstract void
setGroupMemSilence(java.lang.String username,
java.lang.String appKey,
boolean keepSilence,
BasicCallback callback)
已过时。
deprecated in 2.8.2 use#addGroupSilenceWithTime(List, long, BasicCallback)
,#delGroupSilence(List, BasicCallback)
instead
<code>abstract void</code> <code>setMemNickname(java.lang.String username,
java.lang.String appKey,
java.lang.String nickName,
BasicCallback callback)</code>
修改群成员昵称,群成员仅能修改自己在此群的昵称,管理员或群主修改任何普通群成员在此群的昵称,群成员类型见GroupMemberInfo.type
abstract void
setNoDisturb(int noDisturb,
BasicCallback callback)
将此群组设置为免打扰。
abstract void
setTopAnnouncement(int announceID,
boolean isTop,
BasicCallback callback)
设置置顶状态,本设置为改变置顶状态和置顶时间,同时会导致公告的排序发生改变getAnnouncementsByOrder(RequestCallback)
设置成功时,群内所有成员会收到GroupAnnouncementChangedEvent
abstract void
updateAvatar(java.io.File avatar,
java.lang.String format,
BasicCallback callback)
更新群组头像,建议用户在上传头像前先对头像先进行压缩,否则在调用getBigAvatarBitmap(GetAvatarBitmapCallback)
接口拿头像的原图时,有可能会抛出OOM异常。
abstract void
updateDescription(java.lang.String groupDesc,
BasicCallback callback)
修改群组描述,新的描述不允许为空
abstract void
updateName(java.lang.String groupName,
BasicCallback callback)
修改群组名称,新的群名称不允许为空
-
从类继承的方法 cn.jpush.im.android.api.model.GroupBasicInfo
fromJsonToGroupBasicCollection, getAvatar, getGroupDescription, getGroupFlag, getGroupID, getGroupLevel, getGroupName, getGroupType, getMaxMemberCount, groupBasicCollectionToJson, toJson
-
从类继承的方法 java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
构造器详细资料
-
GroupInfo
public GroupInfo()
方法详细资料
-
getNoDisturb
public abstract int getNoDisturb()
群组是否在免打扰名单中
- 返回:
- 1表示存在,0表示不存在
-
getGroupOwner
public abstract java.lang.String getGroupOwner()
已过时。 in 2.7.0 usegetOwnerMemberInfo()
instead
获取群主的username
- 返回:
-
getOwnerAppkey
public abstract java.lang.String getOwnerAppkey()
已过时。 in 2.7.0 usegetOwnerMemberInfo()
instead
获取群主所属appkey
- 从以下版本开始:
- 1.4.0
-
getOwnerMemberInfo
public abstract GroupMemberInfo getOwnerMemberInfo()
获取群主的群内信息GroupMemberInfo
- 返回:
- GroupMemberInfo
- 从以下版本开始:
- 2.7.0
-
getGroupMembers
public abstract java.util.List<UserInfo> getGroupMembers()
已过时。 deprecated in 2.7.0, usegetGroupMemberInfos()
获取群成员userinfo列表。
- 返回:
-
getGroupMemberInfos
public abstract java.util.List<GroupMemberInfo> getGroupMemberInfos()
获取群成员GroupMemberInfo
列表
- 返回:
- GroupMemberInfo列表
- 从以下版本开始:
- 2.7.0
-
getGroupMemberInfo
@Deprecated public abstract UserInfo getGroupMemberInfo(java.lang.String username)
已过时。 deprecated in jmessage 1.3.0 use getGroupMemberInfo(String, String)
instead.
获取单个群成员Userinfo,默认获取本应用appkey下用户信息,如果需要获取跨应用 下其他用户的用户信息,请使用getGroupMemberInfo(String, String)
- 参数:
- <code>username</code> - 指定群成员的username
- 返回:
- 指定username的用户信息,如果本地未找到则返回null
-
getGroupMemberInfo
public abstract UserInfo getGroupMemberInfo(java.lang.String username, java.lang.String appKey)
已过时。 deprecated in jmessage 2.7.0 usergetGroupMember(String, String)
instead
根据appKey跨应用获取单个群成员UserInfo
- 参数:
- <code>username</code> - 指定群成员的username
- <code>appKey</code> - 群成员所属的appKey,传入空则默认使用本应用appKey
- 返回:
- 指定username的用户信息,如果本地未找到则返回null
-
getGroupMember
public abstract GroupMemberInfo getGroupMember(java.lang.String username, java.lang.String appKey)
根据appKey跨应用获取单个群成员GroupMemberInfo
- 参数:
- <code>username</code> - 指定群成员的username
- <code>appKey</code> - 群成员所属的appKey,传入空则默认使用本应用appKey
- 返回:
- 指定的群组用户信息,如果本地未找到则返回null
- 从以下版本开始:
- 2.7.0
-
setNoDisturb
public abstract void setNoDisturb(int noDisturb, BasicCallback callback)
将此群组设置为免打扰。设置之后收到此群消息时将不会在通知栏展示通知
- 参数:
- <code>noDisturb</code> - 1 -- 免打扰,其他 -- 非免打扰
- <code>callback</code> - 回调接口
-
setBlockGroupMessage
public abstract void setBlockGroupMessage(int blocked, BasicCallback callback)
设置屏蔽群消息,设置后将不会再收到此群的消息
- 参数:
- <code>blocked</code> - 1 -- 设置屏蔽; 其他(int) -- 取消屏蔽
- <code>callback</code> - 回调接口
- 从以下版本开始:
- 2.1.0
-
isGroupBlocked
public abstract int isGroupBlocked()
群组是否在被屏蔽的名单中
- 返回:
- 1 -- 存在; 0 -- 不存在
- 从以下版本开始:
- 2.1.0
-
getAvatarFile
public abstract java.io.File getAvatarFile()
从本地获取群头像缩略图文件,头像缩略图会在调用JMessageClient.getGroupInfo(long, GetGroupInfoCallback)
时自动下载。当此群未设置头像,或者自动下载失败时此接口返回Null。
- 返回:
- 群组缩略头像文件对象,若未设置头像或者未下载完成则返回null
- 从以下版本开始:
- 2.3.0
-
getAvatarBitmap
public abstract void getAvatarBitmap(GetAvatarBitmapCallback callback)
从本地获取群组头像的缩略图bitmap,如果本地存在头像缩略图文件,直接返回;若不存在,会异步从服务器拉取。 下载完成后 会将头像保存至本地并返回。当群组未设置头像,或者下载失败时回调返回Null。
所有的缩略头像bitmap在sdk内都会缓存, 并且会有清理机制,所以上层不需要对缩略头像bitmap做缓存。
- 从以下版本开始:
- 2.3.0
-
getBigAvatarFile
public abstract java.io.File getBigAvatarFile()
从本地获取群组头像原图文件,当群组未设置头像,或者本地不存在头像原图文件时此接口返回Null。
- 返回:
- 群组头像原图文件对象,若未设置头像或者本地不存在头像原图文件则返回null
- 从以下版本开始:
- 2.3.0
-
getBigAvatarBitmap
public abstract void getBigAvatarBitmap(GetAvatarBitmapCallback callback)
从本地获取群组头像的原图bitmap,如果本地存在头像原图文件,直接返回;若不存在,会异步从服务器拉取。 下载完成后 会将头像保存至本地并返回。当群组未设置头像,或者下载失败时回调返回Null。
注意:在调用updateAvatar(File, String, BasicCallback)
上传头像时,若 上传的头像未经压缩处理,调此接口则有可能出现OOM
- 从以下版本开始:
- 2.3.0
-
updateAvatar
public abstract void updateAvatar(java.io.File avatar, java.lang.String format, BasicCallback callback)
更新群组头像,建议用户在上传头像前先对头像先进行压缩,否则在调用getBigAvatarBitmap(GetAvatarBitmapCallback)
接口拿头像的原图时,有可能会抛出OOM异常。
此接口可以指定头像文件在后台存储时的扩展名,如果填空或者不填,则后台存储文件时将没有扩展名。
- 参数:
- <code>avatar</code> - 头像文件
- <code>format</code> - 文件扩展名,注意名称中不要包括"."
- <code>callback</code> - 回调对象
- 从以下版本开始:
- 2.3.0
-
updateName
public abstract void updateName(java.lang.String groupName, BasicCallback callback)
修改群组名称,新的群名称不允许为空
- 参数:
- <code>groupName</code> - 群名称
- <code>callback</code> - 回调接口
- 从以下版本开始:
- 2.3.0
-
updateDescription
public abstract void updateDescription(java.lang.String groupDesc, BasicCallback callback)
修改群组描述,新的描述不允许为空
- 参数:
- <code>groupDesc</code> - 群组描述
- <code>callback</code> - 回调接口
- 从以下版本开始:
- 2.3.0
-
setGroupMemSilence
public abstract void setGroupMemSilence(java.lang.String username, java.lang.String appKey, boolean keepSilence, BasicCallback callback)
已过时。 deprecated in 2.8.2 use#addGroupSilenceWithTime(List, long, BasicCallback)
,#delGroupSilence(List, BasicCallback)
instead
群成员禁言状态设置,禁言后用户可正常接收消息,但无法向被禁言的群组中发送消息 本方法的禁言为永久禁言,如需批量设置或使用时间参数,请使用#addGroupSilenceWithTime(List, long, BasicCallback)
解禁后可正常发送消息,禁言状态设置成功后群内所有成员将会收到群禁言通知事件 sdk收到群禁言通知事件后会以类型为ContentType.eventNotification
的消息事件方式上报.
- 参数:
- <code>username</code> - 待设置群成员的username
- <code>appKey</code> - 待设置群成员的appKey,传入空则默认使用本应用appKey
- <code>keepSilence</code> - //true 设置禁言, false 取消禁言
- <code>callback</code> -
- 从以下版本开始:
- 2.4.0
-
getGroupSilenceMembers
public abstract java.util.List<UserInfo> getGroupSilenceMembers()
已过时。 deprecated in jmessage 2.7.0 use getGroupSilenceList(RequestCallback)
()} instead
获取群成员禁言列表,返回群内被禁言的成员信息列表 此接口废弃,将无法返回准确数据,请使用getGroupSilenceList(RequestCallback)
- 返回:
- 从以下版本开始:
- 2.4.0
-
getGroupSilenceMemberInfos
public abstract java.util.List<GroupMemberInfo> getGroupSilenceMemberInfos()
已过时。 deprecated in jmessage 2.8.2 use getGroupSilenceList(RequestCallback)
instead
获取群成员禁言列表,返回群内被禁言的成员GroupMemberInfo
列表 此接口废弃,将无法返回准确数据,请使用getGroupSilenceList(RequestCallback)
- 返回:
- 群内被禁言的成员GroupMemberInfo列表
- 从以下版本开始:
- 2.7.0
-
isKeepSilence
public abstract boolean isKeepSilence(java.lang.String username, java.lang.String appKey)
已过时。 deprecated in jmessage 2.8.2 use getGroupMemberSilence(String, String, RequestCallback)
判断用户在该群内是否被禁言,若被禁言返回true,否则返回false 此接口废弃,将无法返回准确数据,请使用getGroupMemberSilence(String, String, RequestCallback)
判断用户是否被禁言
- 参数:
- <code>username</code> - 待判断用户的用户名
- <code>appKey</code> - 待判断用户的appKey,若传入空则默认使用本应用appKey
- 返回:
- 从以下版本开始:
- 2.4.0
-
addGroupKeeper
public abstract void addGroupKeeper(java.util.List<UserInfo> userInfos, BasicCallback callback)
添加群管理员,管理员可以移除、禁言普通群成员,并且在公开群组里可以直接添加群成员和审核入群审批GroupApprovalEvent
.
群主可以添加、取消管理员并且移除或禁言管理员
- 参数:
- <code>userInfos</code> - 群成员UserInfo列表
- <code>callback</code> - 回调
- 从以下版本开始:
- 2.5.0
-
removeGroupKeeper
public abstract void removeGroupKeeper(java.util.List<UserInfo> userInfos, BasicCallback callback)
取消群管理员,管理员角色描述详见官方文档群组管理员
- 参数:
- <code>userInfos</code> - 群成员UserInfo列表
- <code>callback</code> - 回调
- 从以下版本开始:
- 2.5.0
-
getGroupKeepers
public abstract java.util.List<UserInfo> getGroupKeepers()
已过时。 deprecated in jmessage 2.7.0 usegetGroupKeeperMemberInfos()
instead
获取群管理员列表, 返回群内管理员的成员信息列表,管理员角色描述详见官方文档群组管理员
- 返回:
- 管理员的成员信息列表
- 从以下版本开始:
- 2.5.0
-
getGroupKeeperMemberInfos
public abstract java.util.List<GroupMemberInfo> getGroupKeeperMemberInfos()
获取群管理员列表, 返回群内管理员的成员GroupMemberInfo
列表
- 返回:
- 管理员的成员GroupMemberInfo列表
- 从以下版本开始:
- 2.7.0
-
changeGroupAdmin
public abstract void changeGroupAdmin(java.lang.String username, java.lang.String appKey, BasicCallback callback)
移交群主,将群主移交給指定群内成员,移交群主后原群主成为普通群成员.
移交群主成功后群内所有成员会收到群主变更事件,SDK收到事件会以类型为EventNotificationContent.EventNotificationType.group_owner_changed
的消息事件方式上报
- 参数:
- <code>username</code> - 待移交者用户名
- <code>appKey</code> - 待移交者appKey, 若传入空则默认使用本应用appKey
- 从以下版本开始:
- 2.5.0
-
changeGroupType
public abstract void changeGroupType(GroupBasicInfo.Type type, BasicCallback callback)
修改群组类型,群组类型修改成功后群内所有成员会收到群类型变更事件,SDK会以类型为EventNotificationContent.EventNotificationType.group_type_changed
的消息事件方式上报,注意只有群主有权限修改群组类型,并且如果修改后的群组类型未发生改变的话不会有事件上报
- 参数:
- <code>type</code> - 目标群组类型<code>GroupInfo.Type</code>
- <code>callback</code> - 修改群组类型结果回调
- 从以下版本开始:
- 2.6.1
-
setMemNickname
public abstract void setMemNickname(java.lang.String username, java.lang.String appKey, java.lang.String nickName, BasicCallback callback)
修改群成员昵称,群成员仅能修改自己在此群的昵称,管理员或群主修改任何普通群成员在此群的昵称,群成员类型见GroupMemberInfo.type
- 参数:
- <code>username</code> - 群成员用户名
- <code>appKey</code> - 群成员appKey,传入空则默认使用本应用appKey
- <code>nickName</code> - 昵称
- <code>callback</code> - 结果回调
- 从以下版本开始:
- 2.7.0
-
publishGroupAnnouncement
public abstract void publishGroupAnnouncement(java.lang.String text, java.lang.Boolean needSendMessage, PublishAnnouncementCallback callback)
发布群公告(只有群主和管理员有权限发送),选择是否向群中发布消息,sendMessage为true代表发送,false不发送
注意只有发送公告成功时才会向群中发布消息,创建的消息在回调中返回,如果发送公告失败或者创建消息失败则回调中message为null。
消息的发送是否成功可以通过MessageStatus
判断,
Message的extra里带有公告的实现,key为""jmessage_group_announcement", value为jsonString:
{"id": 公告id,"text":"公告内容text,"publisher_uid":发布者uid,"ctime" : 公告发布时间,"gid":群组id}获取方式如下:String announceJson = message.getContent.getStringExtras("jmessage_group_announcement");可自己通过字段去解析json字符串,也可通过GroupAnnouncement.fromJson(String)
得到公告对象 如果needSendMessage为false, 回调中message一直为null。
群公告最多100条,超过老的将会被删除,发布群公告成功时群内所有人会收到GroupAnnouncementChangedEvent
- 参数:
- <code>text</code> - 公告内容字节数不能超过1K(utf-8)
- <code>needSendMessage</code> - 是否需要发送消息
- <code>callback</code> - PublishAnnouncementCallback 回调中包含创建的公告和消息
- 从以下版本开始:
- 2.8.0
-
getAnnouncementsByOrder
public abstract void getAnnouncementsByOrder(RequestCallback<java.util.List<GroupAnnouncement>> callback)
按照顺序(置顶时间倒序,创建时间倒序)获取群内所有公告.
- 参数:
- <code>callback</code> - 回调,如果获取成功但群没有公告则返回一个empty list
- 从以下版本开始:
- 2.8.0
-
delGroupAnnouncement
public abstract void delGroupAnnouncement(int announceID, BasicCallback callback)
删除群内指定id的公告,只有群主和管理员有权限删除
删除群公告成功时群内所有成员会收到GroupAnnouncementChangedEvent
- 参数:
- <code>announceID</code> - 公告id 通过[<code>GroupAnnouncement.getAnnounceID()</code>](../../../../../../cn/jpush/im/android/api/model/GroupAnnouncement.html#getAnnounceID--)获取
- <code>callback</code> - 回调
- 从以下版本开始:
- 2.8.0
-
setTopAnnouncement
public abstract void setTopAnnouncement(int announceID, boolean isTop, BasicCallback callback)
设置置顶状态,本设置为改变置顶状态和置顶时间,同时会导致公告的排序发生改变getAnnouncementsByOrder(RequestCallback)
设置成功时,群内所有成员会收到GroupAnnouncementChangedEvent
- 参数:
- <code>announceID</code> - 公告id, 通过[<code>GroupAnnouncement.getAnnounceID()</code>](../../../../../../cn/jpush/im/android/api/model/GroupAnnouncement.html#getAnnounceID--)获取
- <code>isTop</code> - true置顶, false取消置顶
- <code>callback</code> - 回调
- 从以下版本开始:
- 2.8.0
-
addGroupBlacklist
public abstract void addGroupBlacklist(java.util.List<UserInfo> userInfos, BasicCallback callback)
将用户加到群组黑名单,只有群主和管理员有此权限, 被加入黑名单的用户如果在群内会被踢出群组,黑名单中的用户无法再加入群组
操作成功后群内成员将收到群黑名单变更事件GroupBlackListChangedEvent
- 参数:
- <code>userInfos</code> - 准备加入黑名单的用户userInfo集合
- <code>callback</code> - 回调
- 从以下版本开始:
- 2.8.0
-
delGroupBlacklist
public abstract void delGroupBlacklist(java.util.List<UserInfo> userInfos, BasicCallback callback)
将用户从群组黑名单中移除,只有群主和管理员有此权限.
操作成功后群内成员将收到群黑名单变更事件GroupBlackListChangedEvent
- 参数:
- <code>userInfos</code> - 准备移出黑名单的用户userInfo集合
- <code>callback</code> - 回调
- 从以下版本开始:
- 2.8.0
-
getGroupBlackList
public abstract void getGroupBlackList(RequestCallback<java.util.List<UserInfo>> callback)
获取群组的黑名单用户列表, 按照被拉黑时间倒序排列
- 参数:
- <code>callback</code> - 回调
- 从以下版本开始:
- 2.8.0
-
addGroupSilenceWithTime
public abstract void addGroupSilenceWithTime(java.util.Collection<UserInfo> userInfos, long silenceTime, BasicCallback callback)
设置群成员禁言(可设置禁言时间,批量设置一次最多500个),群主和管理员可以禁言普通群成员, 群主和管理员不能被禁言,重复调用此接口将根据当前时间重新计算结束时间。 禁言后用户可正常接收消息,但无法向被禁言的群组中发送消息,禁言成功后会以系统消息形式通知群内成员
- 参数:
- <code>userInfos</code> - 将要被禁言的用户信息,size <= 500
- <code>silenceTime</code> - 禁言时间,单位:毫秒, 禁言时间最少5分钟(300000毫秒),最长一年(31536000000毫秒),即300000 <= times <= 31536000000
- <code>callback</code> - 禁言结果回调
- 从以下版本开始:
- 2.8.2
-
delGroupSilence
public abstract void delGroupSilence(java.util.Collection<UserInfo> userInfos, BasicCallback callback)
取消群成员禁言(批量设置一次最多500个),取消禁言成功后会以系统消息形式通知群内成员
- 参数:
- <code>userInfos</code> - 将要被解除禁言的用户信息,size <= 500
- <code>callback</code> - 解除禁言结果回调
- 从以下版本开始:
- 2.8.2
-
getGroupSilenceList
public abstract void getGroupSilenceList(RequestCallback<java.util.List<SilenceInfo>> callback)
获取群禁言列表,排序规则以添加入禁言的先后的时间倒序排序(后加入的在前)
- 参数:
- <code>callback</code> - 结果回调
- 从以下版本开始:
- 2.8.2
-
getGroupMemberSilence
public abstract void getGroupMemberSilence(java.lang.String name, java.lang.String appkey, RequestCallback<SilenceInfo> callback)
查询用户在群内的禁言状态,如果用户未处于禁言状态,回调中SilenceInfo为null
- 参数:
- <code>name</code> - 群成员的username
- <code>appkey</code> - 群成员的appKey,传入空则默认使用本应用appKey
- <code>callback</code> - 回调,如果用户未处于禁言状态,回调中SilenceInfo为null
- 从以下版本开始:
- 2.8.2
-
groupCollectionToJson
public static java.lang.String groupCollectionToJson(java.util.Collection<GroupInfo> groupInfos)
将GroupInfo对象的集合类转换为Json字符串,使用fromJsonToGroupCollection(String)
转换回来
- 参数:
- <code>groupInfos</code> - GroupInfo对象的集合
- 返回:
- json格式的String
- 从以下版本开始:
- 2.6.1
-
fromJson
public static GroupInfo fromJson(java.lang.String jsonString)
从Json字符串转换成对象, 转换失败返回null
- 参数:
- <code>jsonString</code> -
- 返回:
- GroupInfo, 失败返回null
- 从以下版本开始:
- 2.6.0
-
fromJsonToGroupCollection
public static java.util.Collection<GroupInfo> fromJsonToGroupCollection(java.lang.String jsonString)
从Json字符串转换成Collection对象,方便GroupInfo的集合类的转换, 转换失败返回null
- 参数:
- <code>jsonString</code> -
- 返回:
- Collection,失败返回null
- 从以下版本开始:
- 2.6.0