RingCentral .Net SDK
Properties | List of all members
RingCentral.SessionResource Class Reference

Properties

string id [get, set]
 Internal object ID Example: 78654321 More...
 
string creationTime [get, set]
 Object creation time Required Format: date-time More...
 
string lastModifiedTime [get, set]
 Object last modification time Required Format: date-time More...
 
string startTime [get, set]
 Session start time. If a session hasn't been started this fields should be set to "scheduledStartTime" Format: date-time More...
 
string endTime [get, set]
 Session end time. If a session hasn't been finished this fields should be set to ("startTime"+"scheduledDuration") Format: date-time More...
 
long? duration [get, set]
 Session duration in seconds rounded up (returned if 'startTime' and 'endTime' are not empty) Format: int32 Example: 3600 More...
 
string title [get, set]
 Session title. If blank - derived from webinar title. Example: Live Broadcasting US More...
 
string description [get, set]
 User-friendly description of the Session. If blank - derived from webinar title. Example: Live session for US-based participants More...
 
string scheduledStartTime [get, set]
 Session scheduled start time. Format: date-time More...
 
long? scheduledDuration [get, set]
 The scheduled duration of the Session in seconds. Format: int32 Example: 1800 More...
 
string timeZone [get, set]
 IANA-compatible time zone name (see https://www.iana.org/time-zones). Example: America/New_York More...
 
string localeCode [get, set]
 Session locale code. Can't be blank or null. Example: en-US Default: en-US More...
 
long? panelJoinTimeOffset [get, set]
 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 More...
 
string broadcastingStartTime [get, set]
 The time when broadcasting started. Format: date-time More...
 
string broadcastingEndTime [get, set]
 The time when broadcasting ended. Format: date-time More...
 
string status [get, set]
 Webinar session status Example: Finished Enum: Scheduled, Active, Finished More...
 
string runtimeStatus [get, set]
 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 More...
 
long? participantCount [get, set]
 The number of participants (of all roles) who joined the webinar Format: int32 Example: 150 More...
 
long? attendeeCount [get, set]
 The number of attendees who joined the webinar Format: int32 Example: 145 More...
 
long? uniqueParticipantCount [get, set]
 Unique number of participants (of all roles) who joined the webinar Format: int32 Example: 140 More...
 
long? uniqueAttendeeCount [get, set]
 Unique number of attendees who joined the webinar Format: int32 Example: 135 More...
 
string videoBridgeId [get, set]
 The RCV bridge id Example: 839874770 More...
 
RecordingExtendedModel recording [get, set]
 
SessionLivestreamMinimalModel[] livestreams [get, set]
 The list of livestreams configured for the session More...
 

Property Documentation

◆ attendeeCount

long? RingCentral.SessionResource.attendeeCount
getset

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

◆ broadcastingEndTime

string RingCentral.SessionResource.broadcastingEndTime
getset

The time when broadcasting ended. Format: date-time

◆ broadcastingStartTime

string RingCentral.SessionResource.broadcastingStartTime
getset

The time when broadcasting started. Format: date-time

◆ creationTime

string RingCentral.SessionResource.creationTime
getset

Object creation time Required Format: date-time

◆ description

string RingCentral.SessionResource.description
getset

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

◆ duration

long? RingCentral.SessionResource.duration
getset

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

◆ endTime

string RingCentral.SessionResource.endTime
getset

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

◆ id

string RingCentral.SessionResource.id
getset

Internal object ID Example: 78654321

◆ lastModifiedTime

string RingCentral.SessionResource.lastModifiedTime
getset

Object last modification time Required Format: date-time

◆ livestreams

SessionLivestreamMinimalModel [] RingCentral.SessionResource.livestreams
getset

The list of livestreams configured for the session

◆ localeCode

string RingCentral.SessionResource.localeCode
getset

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

◆ panelJoinTimeOffset

long? RingCentral.SessionResource.panelJoinTimeOffset
getset

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

◆ participantCount

long? RingCentral.SessionResource.participantCount
getset

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

◆ recording

RecordingExtendedModel RingCentral.SessionResource.recording
getset

◆ runtimeStatus

string RingCentral.SessionResource.runtimeStatus
getset

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

◆ scheduledDuration

long? RingCentral.SessionResource.scheduledDuration
getset

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

◆ scheduledStartTime

string RingCentral.SessionResource.scheduledStartTime
getset

Session scheduled start time. Format: date-time

◆ startTime

string RingCentral.SessionResource.startTime
getset

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

◆ status

string RingCentral.SessionResource.status
getset

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

◆ timeZone

string RingCentral.SessionResource.timeZone
getset

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

◆ title

string RingCentral.SessionResource.title
getset

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

◆ uniqueAttendeeCount

long? RingCentral.SessionResource.uniqueAttendeeCount
getset

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

◆ uniqueParticipantCount

long? RingCentral.SessionResource.uniqueParticipantCount
getset

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

◆ videoBridgeId

string RingCentral.SessionResource.videoBridgeId
getset

The RCV bridge id Example: 839874770


The documentation for this class was generated from the following file: