Skip to content

Join Leave Chatroom

howardfuntek edited this page Feb 7, 2019 · 1 revision

There are three tasks to adujst chatroom members.

  • IMJoinRoomTask to join a existed chatroom
  • IMAddMembersTask to invite members to a existed chatroom
  • IMRemoveMemberTask to remove members from a existed chatroom

Removing self from chatroom means leaving room. Removing others means kicking them out.

Tasks

  • IMJoinRoomTask
IMJoinRoomTask().perform(id: String, isSystemMessageEnabled: Bool)
.done { room in
                
}
Parameter Type Required/Optional Default Value Description
id String Required room id
isSystemMessageEnabled Bool Optional true dertermine if a system message should be appended to the chatroom
  • IMAddMembersTask
IMAddMembersTask().perform(roomID: String, invitees: [String], isSystemMessageEnabled: Bool)
.done { room in
                
}
Parameter Type Required/Optional Default Value Description
roomID String Required room id
invitees [String] Required user ids of invitees
isSystemMessageEnabled Bool Optional true dertermine if a system message should be appended to the chatroom
  • IMRemoveMemberTask
IMRemoveMemberTask().perform(roomdID: String, uid: String)
.done { _ in
                
}
Parameter Type Required/Optional Default Value Description
roomID String Required room id
uid String Required user id
Clone this wiki locally