Package com.ringcentral.definitions
Class WcsSessionResource
java.lang.Object
com.ringcentral.definitions.WcsSessionResource
-
Field Summary
FieldsModifier and TypeFieldDescriptionThe URI for attendees to join the Webinar (if it is a public webinar) Format: uri Example: https://v.ringcentral.com/w/a/join/iuyef77fsj473wn10ashjfk34Object creation time Required Format: date-timeUser-friendly description of the Session.Calculated attribute indicating if there are any unsent/deferred invites to session participantsThe URI to join the webinar as a host Format: uri Example: https://v.ringcentral.com/w/join/de7yd8ew7yfsdfjh899843rgjInternal object ID Example: 78654321Object last modification time Required Format: date-timeSession locale code.Localized time zone description.The time offset (positive, in seconds) indicating how much in advance (comparing to "scheduledStartTime") panel members should join for the pre-webinar team sync Format: int32 Example: 900The duration of the Session in seconds.Session scheduled start time.Session status (for the purposes of Configuration service) Example: Scheduled Enum: Scheduled, Active, FinishedIANA-compatible time zone name (see https://www.iana.org/time-zones).Session title.The RCV bridge id Example: 839874770The RCV bridge password.The RCV bridge PSTN password. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionattendeeJoinUri
(String attendeeJoinUri) creationTime
(String creationTime) description
(String description) hasUnsentInvites
(Boolean hasUnsentInvites) hostJoinUri
(String hostJoinUri) lastModifiedTime
(String lastModifiedTime) localeCode
(String localeCode) localizedTimeZoneDescription
(String localizedTimeZoneDescription) panelJoinTimeOffset
(Long panelJoinTimeOffset) scheduledDuration
(Long scheduledDuration) scheduledStartTime
(String scheduledStartTime) videoBridgeId
(String videoBridgeId) videoBridgePassword
(String videoBridgePassword) videoBridgePstnPassword
(String videoBridgePstnPassword)
-
Field Details
-
id
Internal object ID Example: 78654321 -
creationTime
Object creation time Required Format: date-time -
lastModifiedTime
Object last modification time Required Format: date-time -
scheduledStartTime
Session scheduled start time. Required Format: date-time -
scheduledDuration
The duration of the Session in seconds. Required Maximum: 43200 Minimum: 30 Format: int32 Example: 1800 -
timeZone
IANA-compatible time zone name (see https://www.iana.org/time-zones). Required Example: America/New_York -
localizedTimeZoneDescription
Localized time zone description. Example: Eastern Time (America/New_York) -
panelJoinTimeOffset
The time offset (positive, in seconds) indicating how much in advance (comparing to "scheduledStartTime") panel members should join for the pre-webinar team sync Format: int32 Example: 900 -
title
Session title. Can be left blank - then Webinar title should be used for presentation. Example: Live Broadcasting US -
description
User-friendly description of the Session. Can be left blank - then Webinar title should be used for presentation. Example: Live session for US-based participants -
status
Session status (for the purposes of Configuration service) Example: Scheduled Enum: Scheduled, Active, Finished -
hostJoinUri
The URI to join the webinar as a host Format: uri Example: https://v.ringcentral.com/w/join/de7yd8ew7yfsdfjh899843rgj -
localeCode
Session locale code. Can't be blank or null Example: en-US -
videoBridgeId
The RCV bridge id Example: 839874770 -
videoBridgePassword
The RCV bridge password. Returned only if requested by Host/Co-host/Panelist and a password for the bridge is set. Format: password Example: abc123 -
videoBridgePstnPassword
The RCV bridge PSTN password. Returned only if requested by Host/Co-host/Panelist and a PSTN password for the bridge is set. Format: password Example: abc123 -
attendeeJoinUri
The URI for attendees to join the Webinar (if it is a public webinar) Format: uri Example: https://v.ringcentral.com/w/a/join/iuyef77fsj473wn10ashjfk34 -
hasUnsentInvites
Calculated attribute indicating if there are any unsent/deferred invites to session participants
-
-
Constructor Details
-
WcsSessionResource
public WcsSessionResource()
-
-
Method Details
-
id
-
creationTime
-
lastModifiedTime
-
scheduledStartTime
-
scheduledDuration
-
timeZone
-
localizedTimeZoneDescription
-
panelJoinTimeOffset
-
title
-
description
-
status
-
hostJoinUri
-
localeCode
-
videoBridgeId
-
videoBridgePassword
-
videoBridgePstnPassword
-
attendeeJoinUri
-
hasUnsentInvites
-