ParticipantPermissionsUpdate

@Serializable
data class ParticipantPermissionsUpdate(hasPresence: Boolean?, canSend: Set<CanSendPermission>?, canAdmin: Set<CanAdminPermission>?, canReceive: CanReceivePermissionUpdate?)

A desired update to a remote participant's permissions.

Permissions updates work as follows:

  • canAdmin -> if provided, overwrites participant's previous canAdmin value

  • canSend -> if provided, overwrites participant's previous canReceive value

  • hasPresence -> if provided, overwrites participant's previous hasPresence value

  • canReceive ->

  • base -> if provided, overwrites participant's previous canReceive.base value

  • byUserId -> if provided, overwrites participant's previous canReceive.byUserId value

  • byParticipantId -> if provided, overwrites participant's previous canReceive.byParticipantId value

Any permission that is not specified will not be updated.

Constructors

Link copied to clipboard
fun ParticipantPermissionsUpdate(hasPresence: Boolean? = null, canSend: Set<CanSendPermission>? = null, canAdmin: Set<CanAdminPermission>? = null, canReceive: CanReceivePermissionUpdate? = null)

Properties

Link copied to clipboard
val canAdmin: Set<CanAdminPermission>? = null

Which admin tasks a participant is allowed to do.

Link copied to clipboard
val canReceive: CanReceivePermissionUpdate? = null

Which media a participant is allowed to receive.

Link copied to clipboard
val canSend: Set<CanSendPermission>? = null

Which kinds of media a participant is allowed to send.

Link copied to clipboard
val hasPresence: Boolean? = null

Whether the participant has presence (i.e. whether they show up in others' participants()).