com.aspose.email

Interface IGmailClient

All Superinterfaces:

AutoCloseable, Closeable, IBaseGmailClient, IDisposable

public interface IGmailClient
extends IBaseGmailClient

Represents the interface for Gmail client

Method Summary

Methods

Modifier and Type	Method and Description
void	clearCalendar(String calendarId) Clears a calendar.
AccessControlRule	createAccessRule(String calendarId, AccessControlRule role) Creates access rule
Appointment	createAppointment(String calendarId, Appointment appointment) Creates an appointment.
String	createCalendar(Calendar calendar) Creates a calendar.
String	createCalendar(Calendar calendar, boolean useColorRgbFormat) Creates a calendar.
String	createContact(Contact contact) Creates contact for specified email
String	createContact(Contact contact, String emailAddress) Creates contact for specified email
ContactPhoto	createContactPhoto(Contact contact, byte[] imageData) Creates contact photo
void	deleteAccessRule(String calendarId, String roleId) Deletes access rule
void	deleteAppointment(String calendarId, String appointmentId) Deletes an appointment.
void	deleteCalendar(String calendarId) Deletes a calendar.
void	deleteContact(String contactUri) Deletes specified contact
void	deleteContactPhoto(ContactPhoto contactPhoto) Deletes contact photo
AccessControlRule	fetchAccessRule(String calendarId, String roleId) Fetches access rule
Appointment	fetchAppointment(String calendarId, String appointmentId) Fetches appointment by identifier.
ExtendedCalendar	fetchCalendar(String calendarId) Fetches calendar by identifier.
Contact[]	getAllContacts() Fetches all contacts.
ContactGroupCollection	getAllGroups() Fetches all contact groups.
ColorsInfo	getColors() Gets color information
Contact	getContact(Contact contact)
Contact	getContact(String contactUri) Fetches contact
Contact[]	getContactsFromGroup(String groupId) Fetches contacts belonging to the group specified.
FreebusyResponse	getFreebusyInfo(FreebusyQuery query) Gets free/busy information
ContactPhoto	getPhoto(ContactPhoto photo) Fetches a contact photo
ContactPhoto	getPhoto(String photoUri) Fetches a contact photo
String	getSetting(String setting) Gets settings by the name
Dictionary<String,String>	getSettings() Gets settings dictionary
Appointment	importAppointment(String calendarId, Appointment appointment) Imports appointment to calendar
AccessControlRule[]	listAccessRules(String calendarId) Gets list of access rules
Appointment[]	listAppointmentInstances(String calendarId, String appointmentId) Gets list of an appointment instances for calendar.
Appointment[]	listAppointments(String calendarId) Gets list of an appointments for calendar.
ExtendedCalendar[]	listCalendars() Gets array of calendars.
ExtendedCalendar[]	listCalendars(int minAccessRole, boolean showHidden) Gets array of calendars.
Appointment	moveAppointment(String sourceCalendarId, String destinationCalendarId, String appointmentId) Moves an appointment to another calendar.
Appointment	moveAppointment(String sourceCalendarId, String destinationCalendarId, String appointmentId, boolean sendNotifications) Moves an appointment to another calendar.
AccessControlRule	updateAccessRule(String calendarId, AccessControlRule role) Updates access rule
Appointment	updateAppointment(String calendarId, Appointment appointment) Updates an appointment.
void	updateCalendar(Calendar calendar) Updates a calendar
void	updateCalendar(Calendar calendar, boolean useColorRgbFormat) Updates a calendar
Contact	updateContact(Contact contact) Updates contact
void	updateContactPhoto(ContactPhoto contactPhoto) Creates or updates contact photo

Methods inherited from interface com.aspose.email.IBaseGmailClient

close, getAccessToken, getDefaultEmail, getProxy, getTimeout, refreshToken, setAccessToken, setProxy, setTimeout

Methods inherited from interface IDisposable

dispose

Method Detail

listCalendars

ExtendedCalendar[] listCalendars()

Gets array of calendars.

Returns:

Returns array of calendars.

listCalendars

ExtendedCalendar[] listCalendars(int minAccessRole,
                               boolean showHidden)

Gets array of calendars.

Parameters:

minAccessRole - The effective access role that the authenticated user has on the calendar.

showHidden - Show hidden calendars

Returns:

Returns array of calendars.

createCalendar

String createCalendar(Calendar calendar)

Creates a calendar.

Parameters:

calendar - An instance of calendar object to create.

Returns:

Returns calendar identifier

createCalendar

String createCalendar(Calendar calendar,
                    boolean useColorRgbFormat)

Creates a calendar.

Parameters:

calendar - An instance of calendar object to create.

useColorRgbFormat - Indicates whether color rgb format is used.

Returns:

Returns calendar identifier

updateCalendar

void updateCalendar(Calendar calendar)

Updates a calendar

Parameters:

calendar - An instance of calendar object to update.

updateCalendar

void updateCalendar(Calendar calendar,
                  boolean useColorRgbFormat)

Updates a calendar

Parameters:

calendar - An instance of calendar object to update.

useColorRgbFormat - Indicates whether color rgb format is used.

fetchCalendar

ExtendedCalendar fetchCalendar(String calendarId)

Fetches calendar by identifier.

Parameters:

calendarId - Calendar identifier.

Returns:

Returns fetched calendar.

deleteCalendar

void deleteCalendar(String calendarId)

Deletes a calendar.

Parameters:

calendarId - Calendar identifier.

clearCalendar

void clearCalendar(String calendarId)

Clears a calendar.

Parameters:

calendarId - Calendar identifier.

listAppointments

Appointment[] listAppointments(String calendarId)

Gets list of an appointments for calendar.

Parameters:

calendarId - Calendar identifier.

Returns:

Returns list of an appointments for calendar.

listAppointmentInstances

Appointment[] listAppointmentInstances(String calendarId,
                                     String appointmentId)

Gets list of an appointment instances for calendar.

Parameters:

calendarId - Calendar identifier.

appointmentId - Appointment identifier.

Returns:

Returns list of an appointment instances for calendar.

createAppointment

Appointment createAppointment(String calendarId,
                            Appointment appointment)

Creates an appointment.

Parameters:

calendarId - Calendar identifier.

appointment - An instance of appointment object to create.

Returns:

Returns the created appointment.

importAppointment

Appointment importAppointment(String calendarId,
                            Appointment appointment)

Imports appointment to calendar

Parameters:

calendarId - Calendar identifier.

appointment - An instance of appointment object to import.

Returns:

Returns the imported appointment.

fetchAppointment

Appointment fetchAppointment(String calendarId,
                           String appointmentId)

Fetches appointment by identifier.

Parameters:

calendarId - Calendar identifier.

appointmentId - Appointment identifier.

Returns:

Returns fetched appointment.

moveAppointment

Appointment moveAppointment(String sourceCalendarId,
                          String destinationCalendarId,
                          String appointmentId)

Moves an appointment to another calendar.

Parameters:

sourceCalendarId - Identifier of source calendar.

destinationCalendarId - Identifier of destination calendar.

appointmentId - Appointment identifier.

Returns:

Returns moved appointment.

moveAppointment

Appointment moveAppointment(String sourceCalendarId,
                          String destinationCalendarId,
                          String appointmentId,
                          boolean sendNotifications)

Moves an appointment to another calendar.

Parameters:

sourceCalendarId - Identifier of source calendar.

destinationCalendarId - Identifier of destination calendar.

appointmentId - Appointment identifier.

sendNotifications - Specifies whether notification should be sent.

Returns:

Returns moved appointment.

updateAppointment

Appointment updateAppointment(String calendarId,
                            Appointment appointment)

Updates an appointment.

Parameters:

calendarId - Calendar identifier.

appointment - An instance of appointment object to update.

Returns:

Returns updated appointment.

deleteAppointment

void deleteAppointment(String calendarId,
                     String appointmentId)

Deletes an appointment.

Parameters:

calendarId - Calendar identifier.

appointmentId - Appointment identifier.

createAccessRule

AccessControlRule createAccessRule(String calendarId,
                                 AccessControlRule role)

Creates access rule

Parameters:

calendarId - Calendar identifier.

role - Access control rule

Returns:

Returns created access rule

updateAccessRule

AccessControlRule updateAccessRule(String calendarId,
                                 AccessControlRule role)

Updates access rule

Parameters:

calendarId - Calendar identifier.

role - Access control rule

Returns:

Returns updated access rule

fetchAccessRule

AccessControlRule fetchAccessRule(String calendarId,
                                String roleId)

Fetches access rule

Parameters:

calendarId - Calendar identifier.

roleId - Role identifier.

Returns:

Returns fetched access rule

deleteAccessRule

void deleteAccessRule(String calendarId,
                    String roleId)

Deletes access rule

Parameters:

calendarId - Calendar identifier.

roleId - Role identifier.

listAccessRules

AccessControlRule[] listAccessRules(String calendarId)

Gets list of access rules

Parameters:

calendarId - Calendar identifier.

Returns:

Returns list of access rules

getSettings

Dictionary<String,String> getSettings()

Gets settings dictionary

Returns:

Returns settings dictionary

getSetting

String getSetting(String setting)

Gets settings by the name

Parameters:

setting - Setting name

Returns:

Returns settings value

getFreebusyInfo

FreebusyResponse getFreebusyInfo(FreebusyQuery query)

Gets free/busy information

Parameters:

query - Query to get free/busy information

Returns:

Returns free/busy information.

getColors

ColorsInfo getColors()

Gets color information

Returns:

Returns color information

getAllGroups

ContactGroupCollection getAllGroups()

Fetches all contact groups.

Returns:

Contact groups collection

Throws:

WebException - when operation fails

getContact

Contact getContact(String contactUri)

Fetches contact

Parameters:

contactUri - String, that represents contact's uri

Returns:

Contact object, that represents a contact of gmail

Throws:

WebException - when operation fails

getContact

Contact getContact(Contact contact)

Parameters:

contact - Contact to refresh

Returns:

Contact object, that represents a contact of gmail

Throws:

WebException - when operation fails

getContactsFromGroup

Contact[] getContactsFromGroup(String groupId)

Fetches contacts belonging to the group specified.

Parameters:

groupId - string that represents group id for a contact

Returns:

Contacts array

Throws:

ArgumentNullException - groupId is null or empty.

WebException - when operation fails

getAllContacts

Contact[] getAllContacts()

Fetches all contacts.

Returns:

Contacts array

Throws:

WebException - when operation fails

getPhoto

ContactPhoto getPhoto(ContactPhoto photo)

Fetches a contact photo

Parameters:

photo - ContactPhoto object with identifier

Returns:

Returns a contact photo

getPhoto

ContactPhoto getPhoto(String photoUri)

Fetches a contact photo

Parameters:

photoUri - Uri of an image.

Returns:

Returns a contact photo

createContact

String createContact(Contact contact)

Creates contact for specified email

Parameters:

contact - A contact to create.

Returns:

Returns contact uri

createContact

String createContact(Contact contact,
                   String emailAddress)

Creates contact for specified email

Parameters:

contact - A contact to create.

emailAddress - Email address

Returns:

Returns contact uri

updateContact

Contact updateContact(Contact contact)

Updates contact

Parameters:

contact - A contact to update.

deleteContact

void deleteContact(String contactUri)

Deletes specified contact

Parameters:

contactUri - Contact uri

deleteContactPhoto

void deleteContactPhoto(ContactPhoto contactPhoto)

Deletes contact photo

Parameters:

contactPhoto - contact photo

updateContactPhoto

void updateContactPhoto(ContactPhoto contactPhoto)

Creates or updates contact photo

Parameters:

contactPhoto - contact photo

createContactPhoto

ContactPhoto createContactPhoto(Contact contact,
                              byte[] imageData)

Creates contact photo

Parameters:

contact - contact photo

imageData - image data