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 Deletes the meeting identified by the meetingId.
List<AttendeeByMeeting>	getAttendeesByMeetings(String authorization, Long meetingInstanceKey) Get attendees by meeting List all attendees for specified meeting instance key.
String	getBasePath()
List<HistoricalMeeting>	getHistoricalMeetings(String authorization, Date startDate, Date endDate) Get historical meetings Gets historical meetings for the current authenticated organizer.
List<MeetingHistory>	getHistoryMeetings(String authorization, Boolean history, Date startDate, Date endDate) Deprecated. Use getHistoricalMeetings() instead.
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) Deprecated. Use getUpcomingMeetings() instead.
List<UpcomingMeeting>	getUpcomingMeetings(String authorization) Get upcoming meetings Gets upcoming meetings for the current authenticated 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 Updates an existing meeting specified by meetingId.

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

@Deprecated
public List<MeetingScheduled> getScheduledMeetings(String authorization,
                                                     Boolean scheduled)
                                            throws ApiException

Deprecated. Use getUpcomingMeetings() instead.

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<MeetingScheduled>

Throws:

ApiException - If the response status code is not Successful 2xx, or an error has occurred during parameter serialization or response deserialization

getHistoricalMeetings

public List<HistoricalMeeting> getHistoricalMeetings(String authorization,
                                            Date startDate,
                                            Date endDate)
                                              throws ApiException

Get historical meetings Gets historical meetings for the current authenticated organizer. Requires date range for filtering results to only meetings within specified dates.

Parameters:

authorization - Access token

startDate - Required start of date range, in ISO8601 UTC format, e.g. 2015-07-01T22:00:00Z

endDate - Required end of date range, in ISO8601 UTC format, e.g. 2015-07-01T23:00:00Z

Returns:

List<HistoricalMeeting>

Throws:

ApiException - If the response status code is not Successful 2xx, or an error has occurred during parameter serialization or response deserialization

getHistoryMeetings

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

Deprecated. Use getHistoricalMeetings() instead.

Get historical meetings Gets historical meetings for the current authenticated organizer. Requires date range for filtering results to only meetings within specified dates. History searches will contain the parameter 'meetingInstanceKey' which is used in conjunction with the call 'Get Attendees by Meeting' 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, e.g. 2015-07-01T22:00:00Z

endDate - If history=true, required end of date range, in ISO8601 UTC format, e.g. 2015-07-01T23:00:00Z

Returns:

List<MeetingHistory>

Throws:

ApiException - If the response status code is not Successful 2xx, or an error has occurred during parameter serialization or response deserialization

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<MeetingCreated>

Throws:

ApiException - If the response status code is not Successful 2xx, or an error has occurred during parameter serialization or response deserialization

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 - The meeting ID

Returns:

List<MeetingById>

Throws:

ApiException - If the response status code is not Successful 2xx, or an error has occurred during parameter serialization or response deserialization

updateMeeting

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

Update meeting Updates an existing meeting specified by meetingId.

Parameters:

authorization - Access token

meetingId - The meeting ID

body - The meeting details

Throws:

ApiException - If the response status code is not Successful 2xx, or an error has occurred during parameter serialization or response deserialization

deleteMeeting

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

Delete meeting Deletes the meeting identified by the meetingId.

Parameters:

authorization - Access token

meetingId - The meeting ID

Throws:

ApiException - If the response status code is not Successful 2xx, or an error has occurred during parameter serialization or response deserialization

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 - The meeting ID

Returns:

StartUrl

Throws:

ApiException - If the response status code is not Successful 2xx, or an error has occurred during parameter serialization or response deserialization

getAttendeesByMeetings

public List<AttendeeByMeeting> getAttendeesByMeetings(String authorization,
                                             Long meetingInstanceKey)
                                               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 users with the admin role 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

Returns:

List<AttendeeByMeeting>

Throws:

ApiException - If the response status code is not Successful 2xx, or an error has occurred during parameter serialization or response deserialization

getUpcomingMeetings

public List<UpcomingMeeting> getUpcomingMeetings(String authorization)
                                          throws ApiException

Get upcoming meetings Gets upcoming meetings for the current authenticated organizer.

Parameters:

authorization - Access token

Returns:

List<UpcomingMeeting>

Throws:

ApiException - If the response status code is not Successful 2xx, or an error has occurred during parameter serialization or response deserialization