Package com.ringcentral.definitions

Class SessionBaseModel

java.lang.Object

com.ringcentral.definitions.SessionBaseModel

public class SessionBaseModel
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
Long	attendeeCount	The number of attendees who joined the webinar Format: int32 Example: 145
String	broadcastingEndTime	The time when broadcasting ended.
String	broadcastingStartTime	The time when broadcasting started.
String	description	User-friendly description of the Session.
Long	duration	Session duration in seconds rounded up (returned if 'startTime' and 'endTime' are not empty) Format: int32 Example: 3600
String	endTime	Session end time.
String	localeCode	Session locale code.
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
Long	participantCount	The number of participants (of all roles) who joined the webinar Format: int32 Example: 150
String	runtimeStatus	Session runtime status (for 'Active' Sessions only).
Long	scheduledDuration	The scheduled duration of the Session in seconds.
String	scheduledStartTime	Session scheduled start time.
String	startTime	Session start time.
String	status	Webinar session status Example: Finished Enum: Scheduled, Active, Finished
String	timeZone	IANA-compatible time zone name (see https://www.iana.org/time-zones).
String	title	Session title.
Long	uniqueAttendeeCount	Unique number of attendees who joined the webinar Format: int32 Example: 135
Long	uniqueParticipantCount	Unique number of participants (of all roles) who joined the webinar Format: int32 Example: 140

Constructor Summary

Constructors

Constructor	Description
SessionBaseModel()

Method Summary

Modifier and Type	Method	Description
SessionBaseModel	attendeeCount(Long attendeeCount)
SessionBaseModel	broadcastingEndTime(String broadcastingEndTime)
SessionBaseModel	broadcastingStartTime(String broadcastingStartTime)
SessionBaseModel	description(String description)
SessionBaseModel	duration(Long duration)
SessionBaseModel	endTime(String endTime)
SessionBaseModel	localeCode(String localeCode)
SessionBaseModel	panelJoinTimeOffset(Long panelJoinTimeOffset)
SessionBaseModel	participantCount(Long participantCount)
SessionBaseModel	runtimeStatus(String runtimeStatus)
SessionBaseModel	scheduledDuration(Long scheduledDuration)
SessionBaseModel	scheduledStartTime(String scheduledStartTime)
SessionBaseModel	startTime(String startTime)
SessionBaseModel	status(String status)
SessionBaseModel	timeZone(String timeZone)
SessionBaseModel	title(String title)
SessionBaseModel	uniqueAttendeeCount(Long uniqueAttendeeCount)
SessionBaseModel	uniqueParticipantCount(Long uniqueParticipantCount)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

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

Constructor Details

SessionBaseModel

public SessionBaseModel()

Method Details

startTime

public SessionBaseModel startTime(String startTime)

endTime

public SessionBaseModel endTime(String endTime)

duration

public SessionBaseModel duration(Long duration)

title

public SessionBaseModel title(String title)

description

public SessionBaseModel description(String description)

scheduledStartTime

public SessionBaseModel scheduledStartTime(String scheduledStartTime)

scheduledDuration

public SessionBaseModel scheduledDuration(Long scheduledDuration)

timeZone

public SessionBaseModel timeZone(String timeZone)

localeCode

public SessionBaseModel localeCode(String localeCode)

panelJoinTimeOffset

public SessionBaseModel panelJoinTimeOffset(Long panelJoinTimeOffset)

broadcastingStartTime

public SessionBaseModel broadcastingStartTime(String broadcastingStartTime)

broadcastingEndTime

public SessionBaseModel broadcastingEndTime(String broadcastingEndTime)

status

public SessionBaseModel status(String status)

runtimeStatus

public SessionBaseModel runtimeStatus(String runtimeStatus)

participantCount

public SessionBaseModel participantCount(Long participantCount)

attendeeCount

public SessionBaseModel attendeeCount(Long attendeeCount)

uniqueParticipantCount

public SessionBaseModel uniqueParticipantCount(Long uniqueParticipantCount)

uniqueAttendeeCount

public SessionBaseModel uniqueAttendeeCount(Long uniqueAttendeeCount)