Package com.ringcentral.paths.webinar.configuration.v1.webinars.sessions

Class Index

java.lang.Object

com.ringcentral.paths.webinar.configuration.v1.webinars.sessions.Index

public class Index
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
Index	parent
RestClient	rc
String	sessionId

Constructor Summary

Constructors

Constructor	Description
Index(Index parent, String sessionId)

Method Summary

Modifier and Type	Method	Description
String	delete()	Deletes a Webinar Session.
WcsSessionResource	get()	Returns a Webinar Session by ID.
Index	invitees()
Index	invitees(String inviteeId)
WcsSessionResource	patch(WcsSessionWithLocaleCodeModel wcsSessionWithLocaleCodeModel)	Updates a Webinar Session.
String	path()
String	path(Boolean withParameter)
WcsSessionResource	post(WcsSessionWithLocaleCodeModel wcsSessionWithLocaleCodeModel)	Creates a new Session for a given Webinar HTTP Method: post Endpoint: /webinar/configuration/v1/webinars/{webinarId}/sessions Rate Limit Group: Heavy App Permission: EditWebinars

Methods inherited from class java.lang.Object

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

Field Details

rc

public RestClient rc

parent

public Index parent

sessionId

public String sessionId

Constructor Details

Index

public Index(Index parent,
 String sessionId)

Method Details

path

public String path(Boolean withParameter)

path

public String path()

post

public WcsSessionResource post(WcsSessionWithLocaleCodeModel wcsSessionWithLocaleCodeModel)
                        throws RestException,
IOException

Creates a new Session for a given Webinar HTTP Method: post Endpoint: /webinar/configuration/v1/webinars/{webinarId}/sessions Rate Limit Group: Heavy App Permission: EditWebinars

Throws:

RestException

IOException

get

public WcsSessionResource get()
                       throws RestException,
IOException

Returns a Webinar Session by ID. HTTP Method: get Endpoint: /webinar/configuration/v1/webinars/{webinarId}/sessions/{sessionId} Rate Limit Group: Heavy App Permission: ReadWebinars

Throws:

RestException

IOException

delete

public String delete()
              throws RestException,
IOException

Deletes a Webinar Session. All child objects (Invitees) will be also deleted. It is disallowed to delete a Session which is in 'Active' or 'Finished' state

HTTP Method: delete Endpoint: /webinar/configuration/v1/webinars/{webinarId}/sessions/{sessionId} Rate Limit Group: Heavy App Permission: EditWebinars

Throws:

RestException

IOException

patch

public WcsSessionResource patch(WcsSessionWithLocaleCodeModel wcsSessionWithLocaleCodeModel)
                         throws RestException,
IOException

Updates a Webinar Session. The payload may contain certain attributes from the Session resource (it is a partial update). Changing the 'status' field usually invokes certain workflow actions. Updating a Session in 'Active' or 'Finished' status is prohibited. Some status transitions (for example, to 'Active" or 'Finished') may be prohibited.

HTTP Method: patch Endpoint: /webinar/configuration/v1/webinars/{webinarId}/sessions/{sessionId} Rate Limit Group: Heavy App Permission: EditWebinars

Throws:

RestException

IOException

invitees

public Index invitees()

invitees

public Index invitees(String inviteeId)