IGmailClient

All Implemented Interfaces: com.aspose.email.IBaseGmailClient

public interface IGmailClient extends IBaseGmailClient

Represents the interface for Gmail client

Methods

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

clearCalendar(String calendarId)

public abstract void clearCalendar(String calendarId)

Clears a calendar.

Parameters:

Parameter	Type	Description
calendarId	java.lang.String	Calendar identifier.

createAccessRule(String calendarId, AccessControlRule role)

public abstract AccessControlRule createAccessRule(String calendarId, AccessControlRule role)

Creates access rule

Parameters:

Parameter	Type	Description
calendarId	java.lang.String	Calendar identifier.
role	AccessControlRule	Access control rule

Returns: AccessControlRule - Returns created access rule

createAppointment(String calendarId, Appointment appointment)

public abstract Appointment createAppointment(String calendarId, Appointment appointment)

Creates an appointment.

Parameters:

Parameter	Type	Description
calendarId	java.lang.String	Calendar identifier.
appointment	Appointment	An instance of appointment object to create.

Returns: Appointment - Returns the created appointment.

createCalendar(Calendar calendar)

public abstract String createCalendar(Calendar calendar)

Creates a calendar.

Parameters:

Parameter	Type	Description
calendar	Calendar	An instance of calendar object to create.

Returns: java.lang.String - Returns calendar identifier

createCalendar(Calendar calendar, boolean useColorRgbFormat)

public abstract String createCalendar(Calendar calendar, boolean useColorRgbFormat)

Creates a calendar.

Parameters:

Parameter	Type	Description
calendar	Calendar	An instance of calendar object to create.
useColorRgbFormat	boolean	Indicates whether color rgb format is used.

Returns: java.lang.String - Returns calendar identifier

createContact(Contact contact)

public abstract String createContact(Contact contact)

Creates contact for specified email

Parameters:

Parameter	Type	Description
contact	Contact	A contact to create.

Returns: java.lang.String - Returns contact uri

createContact(Contact contact, String emailAddress)

public abstract String createContact(Contact contact, String emailAddress)

Creates contact for specified email

Parameters:

Parameter	Type	Description
contact	Contact	A contact to create.
emailAddress	java.lang.String	Email address

Returns: java.lang.String - Returns contact uri

createContactPhoto(Contact contact, byte[] imageData)

public abstract ContactPhoto createContactPhoto(Contact contact, byte[] imageData)

Creates contact photo

Parameters:

Parameter	Type	Description
contact	Contact	contact photo
imageData	byte[]	image data

Returns: ContactPhoto

deleteAccessRule(String calendarId, String roleId)

public abstract void deleteAccessRule(String calendarId, String roleId)

Deletes access rule

Parameters:

Parameter	Type	Description
calendarId	java.lang.String	Calendar identifier.
roleId	java.lang.String	Role identifier.

deleteAppointment(String calendarId, String appointmentId)

public abstract void deleteAppointment(String calendarId, String appointmentId)

Deletes an appointment.

Parameters:

Parameter	Type	Description
calendarId	java.lang.String	Calendar identifier.
appointmentId	java.lang.String	Appointment identifier.

deleteCalendar(String calendarId)

public abstract void deleteCalendar(String calendarId)

Deletes a calendar.

Parameters:

Parameter	Type	Description
calendarId	java.lang.String	Calendar identifier.

deleteContact(String contactUri)

public abstract void deleteContact(String contactUri)

Deletes specified contact

Parameters:

Parameter	Type	Description
contactUri	java.lang.String	Contact uri

deleteContactPhoto(ContactPhoto contactPhoto)

public abstract void deleteContactPhoto(ContactPhoto contactPhoto)

Deletes contact photo

Parameters:

Parameter	Type	Description
contactPhoto	ContactPhoto	contact photo

fetchAccessRule(String calendarId, String roleId)

public abstract AccessControlRule fetchAccessRule(String calendarId, String roleId)

Fetches access rule

Parameters:

Parameter	Type	Description
calendarId	java.lang.String	Calendar identifier.
roleId	java.lang.String	Role identifier.

Returns: AccessControlRule - Returns fetched access rule

fetchAppointment(String calendarId, String appointmentId)

public abstract Appointment fetchAppointment(String calendarId, String appointmentId)

Fetches appointment by identifier.

Parameters:

Parameter	Type	Description
calendarId	java.lang.String	Calendar identifier.
appointmentId	java.lang.String	Appointment identifier.

Returns: Appointment - Returns fetched appointment.

fetchCalendar(String calendarId)

public abstract ExtendedCalendar fetchCalendar(String calendarId)

Fetches calendar by identifier.

Parameters:

Parameter	Type	Description
calendarId	java.lang.String	Calendar identifier.

Returns: ExtendedCalendar - Returns fetched calendar.

getAllContacts()

public abstract Contact[] getAllContacts()

Fetches all contacts.

Returns: com.aspose.email.Contact[] - Contacts array

getAllGroups()

public abstract ContactGroupCollection getAllGroups()

Fetches all contact groups.

Returns: ContactGroupCollection - Contact groups collection

getColors()

public abstract ColorsInfo getColors()

Gets color information

Returns: ColorsInfo - Returns color information

getContact(Contact contact)

public abstract Contact getContact(Contact contact)

Parameters:

Parameter	Type	Description
contact	Contact	Contact to refresh

Returns: Contact - Contact object, that represents a contact of gmail

getContact(String contactUri)

public abstract Contact getContact(String contactUri)

Fetches contact

Parameters:

Parameter	Type	Description
contactUri	java.lang.String	String, that represents contact’s uri

Returns: Contact - Contact object, that represents a contact of gmail

getContactsFromGroup(String groupId)

public abstract Contact[] getContactsFromGroup(String groupId)

Fetches contacts belonging to the group specified.

Parameters:

Parameter	Type	Description
groupId	java.lang.String	string that represents group id for a contact

Returns: com.aspose.email.Contact[] - Contacts array

getFreebusyInfo(FreebusyQuery query)

public abstract FreebusyResponse getFreebusyInfo(FreebusyQuery query)

Gets free/busy information

Parameters:

Parameter	Type	Description
query	FreebusyQuery	Query to get free/busy information

Returns: FreebusyResponse - Returns free/busy information.

getPhoto(ContactPhoto photo)

public abstract ContactPhoto getPhoto(ContactPhoto photo)

Fetches a contact photo

Parameters:

Parameter	Type	Description
photo	ContactPhoto	ContactPhoto object with identifier

Returns: ContactPhoto - Returns a contact photo

getPhoto(String photoUri)

public abstract ContactPhoto getPhoto(String photoUri)

Fetches a contact photo

Parameters:

Parameter	Type	Description
photoUri	java.lang.String	Uri of an image.

Returns: ContactPhoto - Returns a contact photo

getSetting(String setting)

public abstract String getSetting(String setting)

Gets settings by the name

Parameters:

Parameter	Type	Description
setting	java.lang.String	Setting name

Returns: java.lang.String - Returns settings value

getSettings()

public abstract System.Collections.Generic.Dictionary<String,String> getSettings()

Gets settings dictionary

Returns: com.aspose.ms.System.Collections.Generic.Dictionary<java.lang.String,java.lang.String> - Returns settings dictionary

importAppointment(String calendarId, Appointment appointment)

public abstract Appointment importAppointment(String calendarId, Appointment appointment)

Imports appointment to calendar

Parameters:

Parameter	Type	Description
calendarId	java.lang.String	Calendar identifier.
appointment	Appointment	An instance of appointment object to import.

Returns: Appointment - Returns the imported appointment.

listAccessRules(String calendarId)

public abstract AccessControlRule[] listAccessRules(String calendarId)

Gets list of access rules

Parameters:

Parameter	Type	Description
calendarId	java.lang.String	Calendar identifier.

Returns: com.aspose.email.AccessControlRule[] - Returns list of access rules

listAppointmentInstances(String calendarId, String appointmentId)

public abstract Appointment[] listAppointmentInstances(String calendarId, String appointmentId)

Gets list of an appointment instances for calendar.

Parameters:

Parameter	Type	Description
calendarId	java.lang.String	Calendar identifier.
appointmentId	java.lang.String	Appointment identifier.

Returns: com.aspose.email.Appointment[] - Returns list of an appointment instances for calendar.

listAppointments(String calendarId)

public abstract Appointment[] listAppointments(String calendarId)

Gets list of an appointments for calendar.

Parameters:

Parameter	Type	Description
calendarId	java.lang.String	Calendar identifier.

Returns: com.aspose.email.Appointment[] - Returns list of an appointments for calendar.

listCalendars()

public abstract ExtendedCalendar[] listCalendars()

Gets array of calendars.

Returns: com.aspose.email.ExtendedCalendar[] - Returns array of calendars.

listCalendars(int minAccessRole, boolean showHidden)

public abstract ExtendedCalendar[] listCalendars(int minAccessRole, boolean showHidden)

Gets array of calendars.

Parameters:

Parameter	Type	Description
minAccessRole	int	The effective access role that the authenticated user has on the calendar.
showHidden	boolean	Show hidden calendars

Returns: com.aspose.email.ExtendedCalendar[] - Returns array of calendars.

moveAppointment(String sourceCalendarId, String destinationCalendarId, String appointmentId)

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

Moves an appointment to another calendar.

Parameters:

Parameter	Type	Description
sourceCalendarId	java.lang.String	Identifier of source calendar.
destinationCalendarId	java.lang.String	Identifier of destination calendar.
appointmentId	java.lang.String	Appointment identifier.

Returns: Appointment - Returns moved appointment.

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

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

Moves an appointment to another calendar.

Parameters:

Parameter	Type	Description
sourceCalendarId	java.lang.String	Identifier of source calendar.
destinationCalendarId	java.lang.String	Identifier of destination calendar.
appointmentId	java.lang.String	Appointment identifier.
sendNotifications	boolean	Specifies whether notification should be sent.

Returns: Appointment - Returns moved appointment.

updateAccessRule(String calendarId, AccessControlRule role)

public abstract AccessControlRule updateAccessRule(String calendarId, AccessControlRule role)

Updates access rule

Parameters:

Parameter	Type	Description
calendarId	java.lang.String	Calendar identifier.
role	AccessControlRule	Access control rule

Returns: AccessControlRule - Returns updated access rule

updateAppointment(String calendarId, Appointment appointment)

public abstract Appointment updateAppointment(String calendarId, Appointment appointment)

Updates an appointment.

Parameters:

Parameter	Type	Description
calendarId	java.lang.String	Calendar identifier.
appointment	Appointment	An instance of appointment object to update.

Returns: Appointment - Returns updated appointment.

updateCalendar(Calendar calendar)

public abstract void updateCalendar(Calendar calendar)

Updates a calendar

Parameters:

Parameter	Type	Description
calendar	Calendar	An instance of calendar object to update.

updateCalendar(Calendar calendar, boolean useColorRgbFormat)

public abstract void updateCalendar(Calendar calendar, boolean useColorRgbFormat)

Updates a calendar

Parameters:

Parameter	Type	Description
calendar	Calendar	An instance of calendar object to update.
useColorRgbFormat	boolean	Indicates whether color rgb format is used.

updateContact(Contact contact)

public abstract Contact updateContact(Contact contact)

Updates contact

Parameters:

Parameter	Type	Description
contact	Contact	A contact to update.

Returns: Contact

updateContactPhoto(ContactPhoto contactPhoto)

public abstract void updateContactPhoto(ContactPhoto contactPhoto)

Creates or updates contact photo

Parameters:

Parameter	Type	Description
contactPhoto	ContactPhoto	contact photo