methods/permissions_methods/permissions_methods library
Classes
- BulkUpdateParticipantPermissionsOptions
- LaunchPermissionsOptions
- PermissionCapabilities
- Configuration for what each permission level can do. Each capability can be: "allow" | "approval" | "disallow"
- PermissionConfig
- Permission configuration for all levels. Level "2" (host) always has full permissions - not configurable.
- UpdateParticipantPermissionOptions
- Permission level values:
- UpdatePermissionConfigOptions
Functions
-
bulkUpdateParticipantPermissions(
BulkUpdateParticipantPermissionsOptions options) → Future< void> - Updates multiple participants' permission levels in bulk. Only hosts (islevel === "2") can update permissions. Processes in batches (default max 50 at a time).
-
getDefaultPermissionConfig(
) → PermissionConfig - Returns the default permission configuration.
-
getPermissionConfigFromEventSettings(
{String audioSetting = 'approval', String videoSetting = 'approval', String chatSetting = 'allow'}) → PermissionConfig - Creates a PermissionConfig from event settings. This is useful when permissionConfig is not yet set, extracting initial values from the room's event settings. Both level0 and level1 will have the same initial permissions.
-
launchPermissions(
LaunchPermissionsOptions options) → void -
updateParticipantPermission(
UpdateParticipantPermissionOptions options) → Future< void> - Updates a single participant's permission level. Only hosts (islevel === "2") can update permissions. Cannot change a host's permission level.
-
updatePermissionConfig(
UpdatePermissionConfigOptions options) → Future< void> - Updates the permission configuration for the room. Only hosts (islevel === "2") can update the configuration.
Typedefs
-
BulkUpdateParticipantPermissionsType
= Future<
void> Function(BulkUpdateParticipantPermissionsOptions options) - LaunchPermissionsType = void Function(LaunchPermissionsOptions options)
-
UpdateParticipantPermissionType
= Future<
void> Function(UpdateParticipantPermissionOptions options) -
UpdatePermissionConfigType
= Future<
void> Function(UpdatePermissionConfigOptions options)