# Group

class Group : ConferenceParticipant

A group instance.

This class allows performing actions over this specific group like adding, expelling or checking its participants.

## Properties

callerId
Link copied to clipboard
open override val callerId: String
chatId
Link copied to clipboard
val chatId: String
id
Link copied to clipboard
val id: String
name
Link copied to clipboard
val name: String
participants
Link copied to clipboard
val participants: List<Contact>
ringingStrategy
Link copied to clipboard
val ringingStrategy: RingingStrategy
rx
Link copied to clipboard
val rx: GroupRx

Access to the reactive API of the group.

## Functions

add
Link copied to clipboard
fun add(participant: Contact, onCompletion: (SippoResourceError?) -> Unit)

Adds a new participant to this group. Note: The user needs to be the group's owner.

changeRingingStrategy
Link copied to clipboard
fun changeRingingStrategy(strategy: RingingStrategy, onCompletion: (SippoResourceError?) -> Unit)

Update ringing strategy for this group.

hasParticipant
Link copied to clipboard
fun hasParticipant(participant: Contact, onCompletion: (Either<Boolean, SippoResourceError>) -> Unit)

Checks if a participant belongs to this group.

leave
Link copied to clipboard
fun leave(onCompletion: (SippoResourceError?) -> Unit)

Leaves this group.

remove
Link copied to clipboard
fun remove(participant: Contact, onCompletion: (SippoResourceError?) -> Unit)

Removes a participant from this group. Note: The user needs to be the group's owner.

removeAllParticipants
Link copied to clipboard
fun removeAllParticipants(onCompletion: (SippoResourceError?) -> Unit)

Removes all participants from this group. Note: The user needs to be the group's owner.

reorderParticipants
Link copied to clipboard
fun reorderParticipants(participants: List<Contact>, onCompletion: (SippoResourceError?) -> Unit)

Reorder the participant list for this group.

update
Link copied to clipboard
fun update(name: String, onCompletion: (SippoResourceError?) -> Unit)

Updates the group name. Note: The user needs to be the group's owner.