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

Class Index

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

  • Field Details

  • Constructor Details

    • Index

      public Index(Index parent, String inviteeId)

  • Method Details

    • path

      public String path(Boolean withParameter)

    • path

      public String path()

    • list

      public WcsInviteeListResource list(RcwConfigListInviteesParameters queryParams) throws RestException, IOException
      Returns the list of Invitees (co-hosts and panelists in phase 1 and also invited attendees in subsequent phases) of a given Webinar Session. An implicit record created for a Webinar 'Host' is always returned.

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

      Throws:
      RestException
      IOException

    • list

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

    • patch

      public BulkUpdateInviteesResponse patch(BulkUpdateInviteesRequest bulkUpdateInviteesRequest) throws RestException, IOException
      Adds, updates and deletes Webinar Session invitees in bulk (co-hosts and panelists in phase 1 and also invited attendees in subsequent phases). The payload may contain multiple added, updated or deleted invitees. For each added record 'role' and either 'firstName'/'lastName'/'email' (for non-authenticated users) or 'linkedUser.*' (for authenticated users) must be specified, but not both. For updated invitees 'id' and 'role' must be specified, 'linkedUser' change is not supported. For deleted invitees only there ids should be specified. The response contains added/updated records (full) and deleted records (ids only).

      Deleting an invitee for a Session in 'Active' or 'Finished' status is prohibited.

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

      Throws:
      RestException
      IOException

    • get

      public InviteeResource get() throws RestException, IOException
      Returns a Session Invitee information by ID HTTP Method: get Endpoint: /webinar/configuration/v1/webinars/{webinarId}/sessions/{sessionId}/invitees/{inviteeId} Rate Limit Group: Heavy App Permission: ReadWebinars
      Throws:
      RestException
      IOException

    • put

      public InviteeResource put(UpdateInviteeRequest updateInviteeRequest) throws RestException, IOException
      Updates a Session Invitee. 'role' is required (it can be changed from 'Panelist' to 'CoHost' or vise versa). It is disallowed to update 'linkedUser': it should be done by deleting then adding an invitee. For non-authenticated users 'firstName'/'lastName'/'email' can be specified, but not both. Implicit record created for a Webinar 'Host' cannot be modified. Also it is disallowed to change any other role to 'Host'.

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

      Throws:
      RestException
      IOException

    • delete

      public String delete() throws RestException, IOException
      Deletes a Session Invitee. Implicit record created for a Webinar 'Host' cannot be deleted. Deleting an invitee for a Session in 'Active' or 'Finished' status is prohibited (HTTP 403).

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

      Throws:
      RestException
      IOException