Aspose::Email::Clients::Google::IGmailClient Class Referenceabstract

Represents the interface for Gmail client More...

Inherits Aspose::Email::Clients::Google::IBaseGmailClient.

Public Member Functions

virtual System::ArrayPtr< System::SharedPtr< ExtendedCalendar > > ListCalendars ()=0
 Gets array of calendars. More...
 
virtual System::ArrayPtr< System::SharedPtr< ExtendedCalendar > > ListCalendars (AccessRole minAccessRole, bool showHidden)=0
 Gets array of calendars. More...
 
virtual System::String CreateCalendar (System::SharedPtr< Calendar > calendar)=0
 Creates a calendar. More...
 
virtual System::String CreateCalendar (System::SharedPtr< Calendar > calendar, bool useColorRgbFormat)=0
 Creates a calendar. More...
 
virtual void UpdateCalendar (System::SharedPtr< Calendar > calendar)=0
 Updates a calendar More...
 
virtual void UpdateCalendar (System::SharedPtr< Calendar > calendar, bool useColorRgbFormat)=0
 Updates a calendar More...
 
virtual System::SharedPtr< ExtendedCalendarFetchCalendar (System::String calendarId)=0
 Fetches calendar by identifier. More...
 
virtual void DeleteCalendar (System::String calendarId)=0
 Deletes a calendar. More...
 
virtual void ClearCalendar (System::String calendarId)=0
 Clears a calendar. More...
 
virtual System::ArrayPtr< System::SharedPtr< Aspose::Email::Calendar::Appointment > > ListAppointments (System::String calendarId)=0
 Gets list of an appointments for calendar. More...
 
virtual System::ArrayPtr< System::SharedPtr< Aspose::Email::Calendar::Appointment > > ListAppointmentInstances (System::String calendarId, System::String appointmentId)=0
 Gets list of an appointment instances for calendar. More...
 
virtual System::SharedPtr< Aspose::Email::Calendar::AppointmentCreateAppointment (System::String calendarId, System::SharedPtr< Aspose::Email::Calendar::Appointment > appointment)=0
 Creates an appointment. More...
 
virtual System::SharedPtr< Aspose::Email::Calendar::AppointmentImportAppointment (System::String calendarId, System::SharedPtr< Aspose::Email::Calendar::Appointment > appointment)=0
 Imports appointment to calendar More...
 
virtual System::SharedPtr< Aspose::Email::Calendar::AppointmentFetchAppointment (System::String calendarId, System::String appointmentId)=0
 Fetches appointment by identifier. More...
 
virtual System::SharedPtr< Aspose::Email::Calendar::AppointmentMoveAppointment (System::String sourceCalendarId, System::String destinationCalendarId, System::String appointmentId)=0
 Moves an appointment to another calendar. More...
 
virtual System::SharedPtr< Aspose::Email::Calendar::AppointmentMoveAppointment (System::String sourceCalendarId, System::String destinationCalendarId, System::String appointmentId, bool sendNotifications)=0
 Moves an appointment to another calendar. More...
 
virtual System::SharedPtr< Aspose::Email::Calendar::AppointmentUpdateAppointment (System::String calendarId, System::SharedPtr< Aspose::Email::Calendar::Appointment > appointment)=0
 Updates an appointment. More...
 
virtual void DeleteAppointment (System::String calendarId, System::String appointmentId)=0
 Deletes an appointment. More...
 
virtual System::SharedPtr< AccessControlRuleCreateAccessRule (System::String calendarId, System::SharedPtr< AccessControlRule > role)=0
 Creates access rule More...
 
virtual System::SharedPtr< AccessControlRuleUpdateAccessRule (System::String calendarId, System::SharedPtr< AccessControlRule > role)=0
 Updates access rule More...
 
virtual System::SharedPtr< AccessControlRuleFetchAccessRule (System::String calendarId, System::String roleId)=0
 Fetches access rule More...
 
virtual void DeleteAccessRule (System::String calendarId, System::String roleId)=0
 Deletes access rule More...
 
virtual System::ArrayPtr< System::SharedPtr< AccessControlRule > > ListAccessRules (System::String calendarId)=0
 Gets list of access rules More...
 
virtual System::SharedPtr< System::Collections::Generic::Dictionary< System::String, System::String > > GetSettings ()=0
 Gets settings dictionary More...
 
virtual System::String GetSetting (System::String setting)=0
 Gets settings by the name More...
 
virtual System::SharedPtr< FreebusyResponseGetFreebusyInfo (System::SharedPtr< FreebusyQuery > query)=0
 Gets free/busy information More...
 
virtual System::SharedPtr< ColorsInfoGetColors ()=0
 Gets color information More...
 
virtual System::SharedPtr< ContactGroupCollectionGetAllGroups ()=0
 Fetches all contact groups. More...
 
virtual System::SharedPtr< Aspose::Email::PersonalInfo::ContactGetContact (System::String contactUri)=0
 Fetches contact More...
 
virtual System::SharedPtr< Aspose::Email::PersonalInfo::ContactGetContact (System::SharedPtr< Aspose::Email::PersonalInfo::Contact > contact)=0
 
Parameters
contactContact to refresh
Returns
Contact object, that represents a contact of gmail
Exceptions
WebExceptionwhen operation fails
More...
 
virtual System::ArrayPtr< System::SharedPtr< Aspose::Email::PersonalInfo::Contact > > GetContactsFromGroup (System::String groupId)=0
 Fetches contacts belonging to the group specified. More...
 
virtual System::ArrayPtr< System::SharedPtr< Aspose::Email::PersonalInfo::Contact > > GetAllContacts ()=0
 Fetches all contacts. More...
 
virtual System::SharedPtr< Aspose::Email::PersonalInfo::ContactPhotoGetPhoto (System::SharedPtr< Aspose::Email::PersonalInfo::ContactPhoto > photo)=0
 Fetches a contact photo More...
 
virtual System::SharedPtr< Aspose::Email::PersonalInfo::ContactPhotoGetPhoto (System::String photoUri)=0
 Fetches a contact photo More...
 
virtual System::String CreateContact (System::SharedPtr< Aspose::Email::PersonalInfo::Contact > contact)=0
 Creates contact for specified email More...
 
virtual System::String CreateContact (System::SharedPtr< Aspose::Email::PersonalInfo::Contact > contact, System::String emailAddress)=0
 Creates contact for specified email More...
 
virtual System::SharedPtr< Aspose::Email::PersonalInfo::ContactUpdateContact (System::SharedPtr< Aspose::Email::PersonalInfo::Contact > contact)=0
 Updates contact More...
 
virtual void DeleteContact (System::String contactUri)=0
 Deletes specified contact More...
 
virtual void DeleteContactPhoto (System::SharedPtr< Aspose::Email::PersonalInfo::ContactPhoto > contactPhoto)=0
 Deletes contact photo More...
 
virtual void UpdateContactPhoto (System::SharedPtr< Aspose::Email::PersonalInfo::ContactPhoto > contactPhoto)=0
 Creates or updates contact photo More...
 
virtual System::SharedPtr< Aspose::Email::PersonalInfo::ContactPhotoCreateContactPhoto (System::SharedPtr< Aspose::Email::PersonalInfo::Contact > contact, System::ArrayPtr< uint8_t > imageData)=0
 Creates contact photo More...
 
- Public Member Functions inherited from Aspose::Email::Clients::Google::IBaseGmailClient
virtual System::String get_AccessToken ()=0
 Gets OAuth 2.0 bearer token More...
 
virtual void set_AccessToken (System::String value)=0
 Sets OAuth 2.0 bearer token More...
 
virtual System::SharedPtr< System::Net::IWebProxy > get_Proxy ()=0
 Gets the proxy. More...
 
virtual void set_Proxy (System::SharedPtr< System::Net::IWebProxy > value)=0
 Sets the proxy. More...
 
virtual int32_t get_Timeout ()=0
 Gets the number of milliseconds to wait before the operation times out. The default value is 100,000 milliseconds (100 seconds). More...
 
virtual void set_Timeout (int32_t value)=0
 Sets the number of milliseconds to wait before the operation times out. The default value is 100,000 milliseconds (100 seconds). More...
 
virtual System::String get_DefaultEmail ()=0
 Gets default email address More...
 
virtual void RefreshToken ()=0
 Refresh access token More...
 

Detailed Description

Represents the interface for Gmail client

Member Function Documentation

◆ ClearCalendar()

virtual void Aspose::Email::Clients::Google::IGmailClient::ClearCalendar ( System::String  calendarId)
pure virtual

Clears a calendar.

Parameters
calendarIdCalendar identifier.

◆ CreateAccessRule()

virtual System::SharedPtr<AccessControlRule> Aspose::Email::Clients::Google::IGmailClient::CreateAccessRule ( System::String  calendarId,
System::SharedPtr< AccessControlRule role 
)
pure virtual

Creates access rule

Parameters
calendarIdCalendar identifier.
roleAccess control rule
Returns
Returns created access rule

◆ CreateAppointment()

virtual System::SharedPtr<Aspose::Email::Calendar::Appointment> Aspose::Email::Clients::Google::IGmailClient::CreateAppointment ( System::String  calendarId,
System::SharedPtr< Aspose::Email::Calendar::Appointment appointment 
)
pure virtual

Creates an appointment.

Parameters
calendarIdCalendar identifier.
appointmentAn instance of appointment object to create.
Returns
Returns the created appointment.

◆ CreateCalendar() [1/2]

virtual System::String Aspose::Email::Clients::Google::IGmailClient::CreateCalendar ( System::SharedPtr< Calendar calendar)
pure virtual

Creates a calendar.

Parameters
calendarAn instance of calendar object to create.
Returns
Returns calendar identifier

◆ CreateCalendar() [2/2]

virtual System::String Aspose::Email::Clients::Google::IGmailClient::CreateCalendar ( System::SharedPtr< Calendar calendar,
bool  useColorRgbFormat 
)
pure virtual

Creates a calendar.

Parameters
calendarAn instance of calendar object to create.
useColorRgbFormatIndicates whether color rgb format is used.
Returns
Returns calendar identifier

◆ CreateContact() [1/2]

virtual System::String Aspose::Email::Clients::Google::IGmailClient::CreateContact ( System::SharedPtr< Aspose::Email::PersonalInfo::Contact contact)
pure virtual

Creates contact for specified email

Parameters
contactA contact to create.
Returns
Returns contact uri

◆ CreateContact() [2/2]

virtual System::String Aspose::Email::Clients::Google::IGmailClient::CreateContact ( System::SharedPtr< Aspose::Email::PersonalInfo::Contact contact,
System::String  emailAddress 
)
pure virtual

Creates contact for specified email

Parameters
contactA contact to create.
emailAddressEmail address
Returns
Returns contact uri

◆ CreateContactPhoto()

virtual System::SharedPtr<Aspose::Email::PersonalInfo::ContactPhoto> Aspose::Email::Clients::Google::IGmailClient::CreateContactPhoto ( System::SharedPtr< Aspose::Email::PersonalInfo::Contact contact,
System::ArrayPtr< uint8_t >  imageData 
)
pure virtual

Creates contact photo

Parameters
contactcontact photo
imageDataimage data

◆ DeleteAccessRule()

virtual void Aspose::Email::Clients::Google::IGmailClient::DeleteAccessRule ( System::String  calendarId,
System::String  roleId 
)
pure virtual

Deletes access rule

Parameters
calendarIdCalendar identifier.
roleIdRole identifier.

◆ DeleteAppointment()

virtual void Aspose::Email::Clients::Google::IGmailClient::DeleteAppointment ( System::String  calendarId,
System::String  appointmentId 
)
pure virtual

Deletes an appointment.

Parameters
calendarIdCalendar identifier.
appointmentIdAppointment identifier.

◆ DeleteCalendar()

virtual void Aspose::Email::Clients::Google::IGmailClient::DeleteCalendar ( System::String  calendarId)
pure virtual

Deletes a calendar.

Parameters
calendarIdCalendar identifier.

◆ DeleteContact()

virtual void Aspose::Email::Clients::Google::IGmailClient::DeleteContact ( System::String  contactUri)
pure virtual

Deletes specified contact

Parameters
contactUriContact uri

◆ DeleteContactPhoto()

virtual void Aspose::Email::Clients::Google::IGmailClient::DeleteContactPhoto ( System::SharedPtr< Aspose::Email::PersonalInfo::ContactPhoto contactPhoto)
pure virtual

Deletes contact photo

Parameters
contactPhotocontact photo

◆ FetchAccessRule()

virtual System::SharedPtr<AccessControlRule> Aspose::Email::Clients::Google::IGmailClient::FetchAccessRule ( System::String  calendarId,
System::String  roleId 
)
pure virtual

Fetches access rule

Parameters
calendarIdCalendar identifier.
roleIdRole identifier.
Returns
Returns fetched access rule

◆ FetchAppointment()

virtual System::SharedPtr<Aspose::Email::Calendar::Appointment> Aspose::Email::Clients::Google::IGmailClient::FetchAppointment ( System::String  calendarId,
System::String  appointmentId 
)
pure virtual

Fetches appointment by identifier.

Parameters
calendarIdCalendar identifier.
appointmentIdAppointment identifier.
Returns
Returns fetched appointment.

◆ FetchCalendar()

virtual System::SharedPtr<ExtendedCalendar> Aspose::Email::Clients::Google::IGmailClient::FetchCalendar ( System::String  calendarId)
pure virtual

Fetches calendar by identifier.

Parameters
calendarIdCalendar identifier.
Returns
Returns fetched calendar.

◆ GetAllContacts()

virtual System::ArrayPtr<System::SharedPtr<Aspose::Email::PersonalInfo::Contact> > Aspose::Email::Clients::Google::IGmailClient::GetAllContacts ( )
pure virtual

Fetches all contacts.

Returns
Contacts array
Exceptions
WebExceptionwhen operation fails

◆ GetAllGroups()

virtual System::SharedPtr<ContactGroupCollection> Aspose::Email::Clients::Google::IGmailClient::GetAllGroups ( )
pure virtual

Fetches all contact groups.

Returns
Contact groups collection
Exceptions
WebExceptionwhen operation fails

◆ GetColors()

virtual System::SharedPtr<ColorsInfo> Aspose::Email::Clients::Google::IGmailClient::GetColors ( )
pure virtual

Gets color information

Returns
Returns color information

◆ GetContact() [1/2]

virtual System::SharedPtr<Aspose::Email::PersonalInfo::Contact> Aspose::Email::Clients::Google::IGmailClient::GetContact ( System::SharedPtr< Aspose::Email::PersonalInfo::Contact contact)
pure virtual

Parameters
contactContact to refresh
Returns
Contact object, that represents a contact of gmail
Exceptions
WebExceptionwhen operation fails

◆ GetContact() [2/2]

virtual System::SharedPtr<Aspose::Email::PersonalInfo::Contact> Aspose::Email::Clients::Google::IGmailClient::GetContact ( System::String  contactUri)
pure virtual

Fetches contact

Parameters
contactUriString, that represents contact's uri
Returns
Contact object, that represents a contact of gmail
Exceptions
WebExceptionwhen operation fails

◆ GetContactsFromGroup()

virtual System::ArrayPtr<System::SharedPtr<Aspose::Email::PersonalInfo::Contact> > Aspose::Email::Clients::Google::IGmailClient::GetContactsFromGroup ( System::String  groupId)
pure virtual

Fetches contacts belonging to the group specified.

Parameters
groupIdstring that represents group id for a contact
Returns
Contacts array
Exceptions
ArgumentNullExceptiongroupId is null or empty.
WebExceptionwhen operation fails

◆ GetFreebusyInfo()

virtual System::SharedPtr<FreebusyResponse> Aspose::Email::Clients::Google::IGmailClient::GetFreebusyInfo ( System::SharedPtr< FreebusyQuery query)
pure virtual

Gets free/busy information

Parameters
queryQuery to get free/busy information
Returns
Returns free/busy information.

◆ GetPhoto() [1/2]

virtual System::SharedPtr<Aspose::Email::PersonalInfo::ContactPhoto> Aspose::Email::Clients::Google::IGmailClient::GetPhoto ( System::SharedPtr< Aspose::Email::PersonalInfo::ContactPhoto photo)
pure virtual

Fetches a contact photo

Parameters
photoContactPhoto object with identifier
Returns
Returns a contact photo

◆ GetPhoto() [2/2]

virtual System::SharedPtr<Aspose::Email::PersonalInfo::ContactPhoto> Aspose::Email::Clients::Google::IGmailClient::GetPhoto ( System::String  photoUri)
pure virtual

Fetches a contact photo

Parameters
photoUriUri of an image.
Returns
Returns a contact photo

◆ GetSetting()

virtual System::String Aspose::Email::Clients::Google::IGmailClient::GetSetting ( System::String  setting)
pure virtual

Gets settings by the name

Parameters
settingSetting name
Returns
Returns settings value

◆ GetSettings()

virtual System::SharedPtr<System::Collections::Generic::Dictionary<System::String, System::String> > Aspose::Email::Clients::Google::IGmailClient::GetSettings ( )
pure virtual

Gets settings dictionary

Returns
Returns settings dictionary

◆ ImportAppointment()

virtual System::SharedPtr<Aspose::Email::Calendar::Appointment> Aspose::Email::Clients::Google::IGmailClient::ImportAppointment ( System::String  calendarId,
System::SharedPtr< Aspose::Email::Calendar::Appointment appointment 
)
pure virtual

Imports appointment to calendar

Parameters
calendarIdCalendar identifier.
appointmentAn instance of appointment object to import.
Returns
Returns the imported appointment.

◆ ListAccessRules()

virtual System::ArrayPtr<System::SharedPtr<AccessControlRule> > Aspose::Email::Clients::Google::IGmailClient::ListAccessRules ( System::String  calendarId)
pure virtual

Gets list of access rules

Parameters
calendarIdCalendar identifier.
Returns
Returns list of access rules

◆ ListAppointmentInstances()

virtual System::ArrayPtr<System::SharedPtr<Aspose::Email::Calendar::Appointment> > Aspose::Email::Clients::Google::IGmailClient::ListAppointmentInstances ( System::String  calendarId,
System::String  appointmentId 
)
pure virtual

Gets list of an appointment instances for calendar.

Parameters
calendarIdCalendar identifier.
appointmentIdAppointment identifier.
Returns
Returns list of an appointment instances for calendar.

◆ ListAppointments()

virtual System::ArrayPtr<System::SharedPtr<Aspose::Email::Calendar::Appointment> > Aspose::Email::Clients::Google::IGmailClient::ListAppointments ( System::String  calendarId)
pure virtual

Gets list of an appointments for calendar.

Parameters
calendarIdCalendar identifier.
Returns
Returns list of an appointments for calendar.

◆ ListCalendars() [1/2]

virtual System::ArrayPtr<System::SharedPtr<ExtendedCalendar> > Aspose::Email::Clients::Google::IGmailClient::ListCalendars ( )
pure virtual

Gets array of calendars.

Returns
Returns array of calendars.

◆ ListCalendars() [2/2]

virtual System::ArrayPtr<System::SharedPtr<ExtendedCalendar> > Aspose::Email::Clients::Google::IGmailClient::ListCalendars ( AccessRole  minAccessRole,
bool  showHidden 
)
pure virtual

Gets array of calendars.

Parameters
minAccessRoleThe effective access role that the authenticated user has on the calendar.
showHiddenShow hidden calendars
Returns
Returns array of calendars.

◆ MoveAppointment() [1/2]

virtual System::SharedPtr<Aspose::Email::Calendar::Appointment> Aspose::Email::Clients::Google::IGmailClient::MoveAppointment ( System::String  sourceCalendarId,
System::String  destinationCalendarId,
System::String  appointmentId 
)
pure virtual

Moves an appointment to another calendar.

Parameters
sourceCalendarIdIdentifier of source calendar.
destinationCalendarIdIdentifier of destination calendar.
appointmentIdAppointment identifier.
Returns
Returns moved appointment.

◆ MoveAppointment() [2/2]

virtual System::SharedPtr<Aspose::Email::Calendar::Appointment> Aspose::Email::Clients::Google::IGmailClient::MoveAppointment ( System::String  sourceCalendarId,
System::String  destinationCalendarId,
System::String  appointmentId,
bool  sendNotifications 
)
pure virtual

Moves an appointment to another calendar.

Parameters
sourceCalendarIdIdentifier of source calendar.
destinationCalendarIdIdentifier of destination calendar.
appointmentIdAppointment identifier.
sendNotificationsSpecifies whether notification should be sent.
Returns
Returns moved appointment.

◆ UpdateAccessRule()

virtual System::SharedPtr<AccessControlRule> Aspose::Email::Clients::Google::IGmailClient::UpdateAccessRule ( System::String  calendarId,
System::SharedPtr< AccessControlRule role 
)
pure virtual

Updates access rule

Parameters
calendarIdCalendar identifier.
roleAccess control rule
Returns
Returns updated access rule

◆ UpdateAppointment()

virtual System::SharedPtr<Aspose::Email::Calendar::Appointment> Aspose::Email::Clients::Google::IGmailClient::UpdateAppointment ( System::String  calendarId,
System::SharedPtr< Aspose::Email::Calendar::Appointment appointment 
)
pure virtual

Updates an appointment.

Parameters
calendarIdCalendar identifier.
appointmentAn instance of appointment object to update.
Returns
Returns updated appointment.

◆ UpdateCalendar() [1/2]

virtual void Aspose::Email::Clients::Google::IGmailClient::UpdateCalendar ( System::SharedPtr< Calendar calendar)
pure virtual

Updates a calendar

Parameters
calendarAn instance of calendar object to update.

◆ UpdateCalendar() [2/2]

virtual void Aspose::Email::Clients::Google::IGmailClient::UpdateCalendar ( System::SharedPtr< Calendar calendar,
bool  useColorRgbFormat 
)
pure virtual

Updates a calendar

Parameters
calendarAn instance of calendar object to update.
useColorRgbFormatIndicates whether color rgb format is used.

◆ UpdateContact()

virtual System::SharedPtr<Aspose::Email::PersonalInfo::Contact> Aspose::Email::Clients::Google::IGmailClient::UpdateContact ( System::SharedPtr< Aspose::Email::PersonalInfo::Contact contact)
pure virtual

Updates contact

Parameters
contactA contact to update.

◆ UpdateContactPhoto()

virtual void Aspose::Email::Clients::Google::IGmailClient::UpdateContactPhoto ( System::SharedPtr< Aspose::Email::PersonalInfo::ContactPhoto contactPhoto)
pure virtual

Creates or updates contact photo

Parameters
contactPhotocontact photo