com.citrix.gotomeeting.api

Class MeetingsApi

java.lang.Object

com.citrix.gotomeeting.api.MeetingsApi

public class MeetingsApi
extends Object

Constructor Summary

Constructors

Constructor and Description
MeetingsApi() Initializes a new instance of the MeetingsApi class using the default endpoint base url for the services being accessed.
MeetingsApi(String basePath) Initializes a new instance of the MeetingsApi class using an endpoint base url other than the default.

Method Summary

Methods

Modifier and Type	Method and Description
List<MeetingCreated>	createMeeting(String Authorization, MeetingReqCreate body) Create meeting Create a new meeting based on the parameters specified.
void	deleteMeeting(String Authorization, Long meetingId) Delete meeting Delete the meeting identified by the meeting key.
List<AttendeeByMeeting>	getAttendeesByMeetings(String Authorization, Long meetingInstanceKey, Date startDate, Date endDate) Get attendees by meeting List all attendees for specified meeting instance key.
String	getBasePath()
List<MeetingHistory>	getHistoryMeetings(String Authorization, Boolean history, Date startDate, Date endDate) Get historical meetings Gets historical meetings for specified organizer.
ApiInvoker	getInvoker()
List<MeetingById>	getMeeting(String Authorization, Long meetingId) Get meeting Returns the meeting details for the specified meeting.
List<MeetingScheduled>	getScheduledMeetings(String Authorization, Boolean scheduled) Get scheduled meetings Gets scheduled meetings (meetings that have not occurred) for a specified organizer.
StartUrl	startMeeting(String Authorization, Long meetingId) Start meeting Returns a host URL that can be used to start a meeting.
void	updateMeeting(String Authorization, Long meetingId, MeetingReqUpdate body) Update meeting Update an existing meeting specified by meeting id.

Methods inherited from class java.lang.Object

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

Constructor Detail

MeetingsApi

public MeetingsApi()

Initializes a new instance of the MeetingsApi class using the default endpoint base url for the services being accessed.

MeetingsApi

public MeetingsApi(String basePath)

Initializes a new instance of the MeetingsApi class using an endpoint base url other than the default. Use this constructor only if you should need to override the default endpoint base url.

Parameters:

basePath - The endpoint base url for the services being accessed.

Method Detail

getInvoker

public ApiInvoker getInvoker()

getBasePath

public String getBasePath()

getScheduledMeetings

public List<MeetingScheduled> getScheduledMeetings(String Authorization,
                                          Boolean scheduled)
                                            throws ApiException

Get scheduled meetings Gets scheduled meetings (meetings that have not occurred) for a specified organizer.

Parameters:

Authorization - Access token.

scheduled - When "true" returns all future meetings.

Returns:

List

Throws:

ApiException

getHistoryMeetings

public List<MeetingHistory> getHistoryMeetings(String Authorization,
                                      Boolean history,
                                      Date startDate,
                                      Date endDate)
                                        throws ApiException

Get historical meetings Gets historical meetings for specified organizer. Requires date range for filtering results to only meetings within specified dates. You can only search 60 days worth of meeting history. History searches will contain a parameter, meetingInstanceKey, which is used in conjunction with Get Attendees by Meeting call to get attendee information for a past meeting.

Parameters:

Authorization - Access token.

history - When "true" returns all past meetings within date range.

startDate - If history=true, required start of date range, in ISO8601 UTC format.

endDate - If history=true, required end of date range, in ISO8601 UTC format.

Returns:

List

Throws:

ApiException

createMeeting

public List<MeetingCreated> createMeeting(String Authorization,
                                 MeetingReqCreate body)
                                   throws ApiException

Create meeting Create a new meeting based on the parameters specified.

Parameters:

Authorization - Access token.

body - The meeting details

Returns:

List

Throws:

ApiException

getMeeting

public List<MeetingById> getMeeting(String Authorization,
                           Long meetingId)
                             throws ApiException

Get meeting Returns the meeting details for the specified meeting.

Parameters:

Authorization - Access token.

meetingId -

Returns:

List

Throws:

ApiException

deleteMeeting

public void deleteMeeting(String Authorization,
                 Long meetingId)
                   throws ApiException

Delete meeting Delete the meeting identified by the meeting key.

Parameters:

Authorization - Access token.

meetingId -

Throws:

ApiException

updateMeeting

public void updateMeeting(String Authorization,
                 Long meetingId,
                 MeetingReqUpdate body)
                   throws ApiException

Update meeting Update an existing meeting specified by meeting id.

Parameters:

Authorization - Access token.

meetingId -

body - The meeting details

Throws:

ApiException

startMeeting

public StartUrl startMeeting(String Authorization,
                    Long meetingId)
                      throws ApiException

Start meeting Returns a host URL that can be used to start a meeting. When this URL is opened in a web browser, the GoToMeeting client will be downloaded and launched and the meeting will start. The end user is not required to login to a client.

Parameters:

Authorization - Access token.

meetingId -

Returns:

StartUrl

Throws:

ApiException

getAttendeesByMeetings

public List<AttendeeByMeeting> getAttendeesByMeetings(String Authorization,
                                             Long meetingInstanceKey,
                                             Date startDate,
                                             Date endDate)
                                               throws ApiException

Get attendees by meeting List all attendees for specified meeting instance key. The meeting instance key is only available for meetings that were successfully started and can be found for historical meetings using Get Meetings, Get Meetings by Organizer, and Get Meetings by Group. For qualified administrative users this call returns attendees for any meeting. For any other user the call will return attendees for meetings on which the user is a valid organizer.

Parameters:

Authorization - Access token.

meetingInstanceKey - The key of the unique meeting instance.

startDate - Required start of date range, in ISO8601 UTC format.

endDate - Required end of date range, in ISO8601 UTC format.

Returns:

List

Throws:

ApiException