61 lines
2.7 KiB
YAML
61 lines
2.7 KiB
YAML
type: object
|
|
properties:
|
|
roomName:
|
|
type: [string, 'null']
|
|
maxLength: 50
|
|
example: 'room'
|
|
default: 'Room'
|
|
description: |
|
|
The display name of the room, used to identify it in a user-friendly way. This value does not need to be unique.
|
|
|
|
Maximum length: 50 characters. If not provided, the default value "Room" will be used.
|
|
autoDeletionDate:
|
|
type: [number, 'null']
|
|
example: 1900000000000
|
|
description: |
|
|
The timestamp (in milliseconds since the Unix epoch) specifying when the room will be automatically deleted.
|
|
This must be at least one hour in the future.
|
|
|
|
After this time, the room is closed to new participants and scheduled for deletion.
|
|
It will be removed after the last participant leaves (graceful deletion).
|
|
|
|
If not set, the room remains active until manually deleted.
|
|
autoDeletionPolicy:
|
|
type: object
|
|
description: >
|
|
Policy for automatic deletion of the room and its contents. This includes
|
|
settings for how the room should be handled when certain conditions are met.
|
|
properties:
|
|
withMeeting:
|
|
type: string
|
|
enum:
|
|
- force
|
|
- when_meeting_ends
|
|
default: when_meeting_ends
|
|
example: when_meeting_ends
|
|
description: |
|
|
Policy for automatic deletion when the room has an active meeting. Options are:
|
|
- force: The meeting will be ended, and the room will be deleted without waiting for participants to leave.
|
|
- when_meeting_ends: The room will be deleted when the meeting ends.
|
|
withRecordings:
|
|
type: string
|
|
enum:
|
|
- force
|
|
- close
|
|
default: close
|
|
example: close
|
|
description: |
|
|
Policy for automatic deletion when the room has recordings. Options are:
|
|
- force: The room and its recordings will be deleted.
|
|
- close: The room will be closed instead of deleted, maintaining its recordings.
|
|
# maxParticipants:
|
|
# type: integer
|
|
# example: 10
|
|
# description: >
|
|
# The maximum number of participants allowed in the room. If the number of participants exceeds
|
|
# this limit, new participants will not be allowed to join.
|
|
preferences:
|
|
$ref: './meet-room-preferences.yaml#/MeetRoomPreferences'
|
|
description: >
|
|
The preferences for the room. These preferences will be used to configure the room's settings.
|