Groups

im.groups handles "My groups", public groups, creating groups, managing members, join applications and invitations, the group blocklist and join links. Roles are represented by GroupRole; whether an operation is allowed is checked by the server.

You want to	See
Show my groups, create a group	List and create
Edit the group profile, show and manage members	Group profile and members
Apply to join, handle invitations and approvals	Applications and invitations
Add people with a link, group blocklist	Join links and blocklist

List and create

import com.deeprespond.im.*

val group = im.groups.create(
    name = "项目讨论",
    type = GroupType.PRIVATE,
    members = listOf("bob"),
)
val info = im.groups.get(group.groupId, refresh = true)

• list() / listFlow() subscribe to my groups. get reads one group and returns null if it isn't visible; lookup gets several group profiles at once; publicGroups pages through public groups by name prefix namePrefix.
• create can also set the avatar, description, announcement, attributes, memberInvite, joinMode and an invitation message for initial members.
• Each initial member's outcome is in CreateGroupResult.results; check code item by item. A successful create doesn't mean every initial member joined.

Group profile and members

im.groups.update(groupId, announcement = "周五下午开会")
val members = im.groups.members(groupId)
try {
    members.loadMore()
    println(members.snapshot.value.items.size)
} finally {
    members.close()
}

• members() / membersFlow() return the member list, filterable by role and muted; lookupMembers looks up members by username.
• updateMember changes a member's group nickname and attributes.
• When several people may edit the group profile, pass the version you read to update. If someone else changed it, the call fails with version_conflict; re-read and decide again.

Operation	Method
Invite, remove members	invite, removeMembers, returning a result per user
Set roles	setRole(groupId, username, role)
Mute, unmute	mute(groupId, username, duration?), unmute
Mute everyone	setMuteAll(groupId, on)
Transfer ownership	transferOwner(groupId, username)
Online count	onlineCount(groupId)
Leave, dissolve	leave(groupId), dismiss(groupId)

Applications and invitations

val status = im.groups.applications.apply(groupId, message = "希望加入")
val invitations = im.groups.invitations.received()
println(status)
println(invitations.items.size)

• apply returns joined (joined the group), pending (awaiting approval) or already_member. applications.mine() lists the user's applications and withdraw withdraws one.
• invitations.accept / decline accept or decline received invitations.
• The owner and admins use requests.list to see the group's applications and invitations, and handle them with approve, decline and withdrawInvite, passing the request kind GroupRequestKind and the other user's username.
• Whether the user must confirm invitations is managed with groups.settings.get() / set(); null uses the app default.
• Whether applying joins directly or needs approval depends on the group type, joinMode and memberInvite. Show the result from the return value; don't infer it from the buttons in your UI.

After invite returns, check each result: a non-empty code means inviting that user failed. On success status is joined (in the group), invited (waiting for the user to confirm), pending_review (waiting for admin approval) or already_member. The call not throwing doesn't mean everyone joined.

The invitation cooldown (group_invite_cooldown_enabled) is set in the console's group runtime policies:

• Off by default: after someone leaves or declines, you can invite them again right away.
• When on: for 24 hours after someone leaves or declines, this group can't invite them again; the result's code is rate_limited with reason declined_cooldown in details.
• The cooldown only limits invitations. Being added by the server, applying and join links aren't affected; requirements like the user's confirmation and admin approval still apply.
• Separately, after a join application is declined, the applicant can't apply again for 24 hours. This always applies.

Join links and blocklist

• The owner and admins manage join links with joinLink.get(), create(expiresIn?) and revoke(). The person opening a link calls preview to see the group first, then join.
• Manage the group blocklist with blacklist.list / add / remove; add can take a reason.
• Duration parameters such as expiresIn and a mute's duration are Kotlin Durations.

For group files, see Files; for sending group messages, see Messages. For full parameters, see GroupsModule.