Package com.ringcentral.definitions

Class SessionResource

java.lang.Object
com.ringcentral.definitions.SessionResource
public class SessionResource extends Object

  • Field Details

    • id

      public String id
      Internal object ID Example: 78654321

    • creationTime

      public String creationTime
      Object creation time Required Format: date-time

    • lastModifiedTime

      public String lastModifiedTime
      Object last modification time Required Format: date-time

    • startTime

      public String startTime
      Session start time. If a session hasn't been started this fields should be set to "scheduledStartTime" Format: date-time

    • endTime

      public String endTime
      Session end time. If a session hasn't been finished this fields should be set to ("startTime"+"scheduledDuration") Format: date-time

    • duration

      public Long duration
      Session duration in seconds rounded up (returned if 'startTime' and 'endTime' are not empty) Format: int32 Example: 3600

    • title

      public String title
      Session title. If blank - derived from webinar title. Example: Live Broadcasting US

    • description

      public String description
      User-friendly description of the Session. If blank - derived from webinar title. Example: Live session for US-based participants

    • scheduledStartTime

      public String scheduledStartTime
      Session scheduled start time. Format: date-time

    • scheduledDuration

      public Long scheduledDuration
      The scheduled duration of the Session in seconds. Format: int32 Example: 1800

    • timeZone

      public String timeZone
      IANA-compatible time zone name (see https://www.iana.org/time-zones). Example: America/New_York

    • localeCode

      public String localeCode
      Session locale code. Can't be blank or null. Example: en-US Default: en-US

    • panelJoinTimeOffset

      public Long 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

    • broadcastingStartTime

      public String broadcastingStartTime
      The time when broadcasting started. Format: date-time

    • broadcastingEndTime

      public String broadcastingEndTime
      The time when broadcasting ended. Format: date-time

    • status

      public String status
      Webinar session status Example: Finished Enum: Scheduled, Active, Finished

    • runtimeStatus

      public String runtimeStatus
      Session runtime status (for 'Active' Sessions only). It is omitted (or null) if the status is not Active Enum: Idle, Practice, GoingLive, Live, Break, Debrief

    • participantCount

      public Long participantCount
      The number of participants (of all roles) who joined the webinar Format: int32 Example: 150

    • attendeeCount

      public Long attendeeCount
      The number of attendees who joined the webinar Format: int32 Example: 145

    • uniqueParticipantCount

      public Long uniqueParticipantCount
      Unique number of participants (of all roles) who joined the webinar Format: int32 Example: 140

    • uniqueAttendeeCount

      public Long uniqueAttendeeCount
      Unique number of attendees who joined the webinar Format: int32 Example: 135

    • videoBridgeId

      public String videoBridgeId
      The RCV bridge id Example: 839874770

    • recording

      public RecordingExtendedModel recording

    • livestreams

      public SessionLivestreamMinimalModel[] livestreams
      The list of livestreams configured for the session

  • Constructor Details

    • SessionResource

      public SessionResource()

  • Method Details