Package com.vonage.client.meetings
Class MeetingRoom
java.lang.Object
com.vonage.client.JsonableBaseObject
com.vonage.client.meetings.MeetingRoom
- All Implemented Interfaces:
Jsonable
-
Nested Class Summary
Nested Classes -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic MeetingRoom.BuilderEntry point for constructing an instance of this class.static MeetingRoomCreates an instance of this class from a JSON payload.The available features for this meeting.The callback URLs for this meeting.The time for when the room was created, expressed in ISO 8601 format.Name of the meeting room.Close the room after a session ends.The time for when the room will be expired, expressed in ISO 8601 format.getId()Identifier of the meeting room.Options for when a participant joins a meeting.Once a room becomes unavailable, no new sessions can be created under it.The level of approval needed to join the meeting in the room.getLinks()Useful links.The meeting code, which is used in the URL to join the meeting.Free text that can be attached to a room.Options for recording.ID of the theme for this room.getType()Type of room.Settings for the user interface of this meeting.Methods inherited from class com.vonage.client.JsonableBaseObject
createJsonObjectMapper, equals, hashCode, toStringMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface com.vonage.client.Jsonable
toJson, updateFromJson
-
Constructor Details
-
MeetingRoom
protected MeetingRoom()
-
-
Method Details
-
getDisplayName
Name of the meeting room.- Returns:
- The display name.
-
getMetadata
Free text that can be attached to a room. This will be passed in the form of a header in events related to this room.- Returns:
- The room description / metadata.
-
getMeetingCode
The meeting code, which is used in the URL to join the meeting.- Returns:
- The share code for this meeting.
-
getType
Type of room.- Returns:
- The room type, as an enum.
-
getIsAvailable
Once a room becomes unavailable, no new sessions can be created under it.- Returns:
- Whether the room is available, or
nullif unknown.
-
getExpireAfterUse
Close the room after a session ends. Only relevant for long_term rooms.- Returns:
trueif the room will close after end of session, ornullif unknown / not applicable.
-
getRecordingOptions
Options for recording.- Returns:
- The recording options.
-
getInitialJoinOptions
Options for when a participant joins a meeting.- Returns:
- The initial joining options.
-
getUiSettings
Settings for the user interface of this meeting.- Returns:
- The UI settings object.
-
getCallbackUrls
The callback URLs for this meeting.- Returns:
- The CallbackUrls object.
-
getAvailableFeatures
The available features for this meeting.- Returns:
- The AvailableFeatures object.
-
getThemeId
ID of the theme for this room.- Returns:
- The theme ID.
-
getJoinApprovalLevel
The level of approval needed to join the meeting in the room.- Returns:
- The approval level, as an enum.
-
getCreatedAt
The time for when the room was created, expressed in ISO 8601 format.- Returns:
- The room creation time.
-
getExpiresAt
The time for when the room will be expired, expressed in ISO 8601 format.- Returns:
- The room expiration time.
-
getId
Identifier of the meeting room.- Returns:
- The room ID.
-
getLinks
Useful links.- Returns:
- The nested links object.
-
fromJson
Creates an instance of this class from a JSON payload.- Parameters:
json- The JSON string to parse.- Returns:
- An instance of this class with the fields populated, if present.
-
builder
Entry point for constructing an instance of this class.- Parameters:
displayName- Name of the meeting room.- Returns:
- A new Builder.
-