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

Class Index

java.lang.Object
com.ringcentral.paths.webinar.configuration.v1.webinars.Index
public class Index extends Object

  • Field Details

  • Constructor Details

    • Index

      public Index(Index parent, String webinarId)

  • Method Details

    • path

      public String path(Boolean withParameter)

    • path

      public String path()

    • list

      public WebinarListResource list(RcwConfigListWebinarsParameters queryParams) throws RestException, IOException
      Returns the list of Webinars hosted by a current authorized user sorted by 'scheduledStartTime' or 'creationTime' in the ascending order.

      HTTP Method: get Endpoint: /webinar/configuration/v1/webinars Rate Limit Group: Heavy App Permission: ReadWebinars

      Throws:
      RestException
      IOException

    • list

      public WebinarListResource list() throws RestException, IOException
      Throws:
      RestException
      IOException

    • post

      public WcsWebinarResource post(WebinarCreationRequest webinarCreationRequest) throws RestException, IOException
      Creates a new webinar.

      If "host" parameter is NOT passed then the current authorized user will become a Host. If "host" parameter is passed then the caller must be a company administrator and have "WebinarSettings" permission. "host.linkedUser.accountId" must be the same as authorized user's account ID.

      The webinar settings which are not mandated at account level or are unlocked can be specified. All other settings are defaulted according to account policy.

      HTTP Method: post Endpoint: /webinar/configuration/v1/webinars Rate Limit Group: Heavy App Permission: EditWebinars

      Throws:
      RestException
      IOException

    • get

      public WcsWebinarResource get() throws RestException, IOException
      Returns a Webinar information by ID. Some webinar settings are returned basing on webinar-level overrides, other - from default settings defined at account level.

      HTTP Method: get Endpoint: /webinar/configuration/v1/webinars/{webinarId} Rate Limit Group: Heavy App Permission: ReadWebinars

      Throws:
      RestException
      IOException

    • delete

      public String delete() throws RestException, IOException
      Deletes a Webinar by ID. All child objects (Sessions, Invitees) will be also deleted. It is disallowed to delete a Webinar which has at least one Session in 'Active' or 'Finished' state.

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

      Throws:
      RestException
      IOException

    • patch

      public WcsWebinarResource patch(WebinarBaseModel webinarBaseModel) throws RestException, IOException
      Updates a Webinar. The payload may contain just changed fields of a Webinar resource (it is a partial update): - host cannot be changed and host user information cannot be updated; - only the settings which are not mandated at account level or are unlocked can be changed; - in order to reset a webinar password it should be passed as an empty string; - "registrationStatus" cannot be changed.

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

      Throws:
      RestException
      IOException

    • sessions

      public Index sessions()

    • sessions

      public Index sessions(String sessionId)