Работа с календарями Gmail

Добавление, редактирование и удаление календаря

Aspose.Email позволяет приложениям управлять календарями Gmail с помощью IGmailClient который предоставляет функции добавления, удаления и обновления календарей Gmail. Этот клиентский класс возвращает список объектов типа ExtendedCalendar, содержащих информацию о элементах календаря Gmail. IGmailClient класс предоставляет следующие функции для календарей:

createCalendar Для вставки нового календаря
listCalendars

Получить список всех календарей клиента

deleteCalendar Можно использовать для удаления календаря
fetchCalendar Можно использовать для получения конкретного календаря клиента
updateCalendar Эта функция используется для повторной вставки измененного календаря клиента

Для доступа к календарям GoogleTestUser инициализируется с использованием учетных данных Gmail. GoogleOAuthHelper используется для получения токена доступа для пользователя, который затем используется для инициализации IGmailClient.

Вставка, получение и обновление

Для вставки календаря инициализируйте Calendar объект типа и вставить его с помощью createCalendar функция. createCalendar возвращает идентификатор только что вставленного календаря. Этот идентификатор можно использовать для получения календаря с сервера. Следующий фрагмент кода показывает, как вставить, получить и обновить календарь.

try (IGmailClient client = GmailClient.getInstance(accessToken, email)) {
    // Insert, get and update calendar
    Calendar calendar = new Calendar("Summary", "Description", "Location", "America/Los_Angeles");

    // Insert calendar and Retrieve same calendar using id
    String id = client.createCalendar(calendar);
    Calendar cal = client.fetchCalendar(id);

    // Change information in the fetched calendar and Update calendar
    cal.setDescription("New Description");
    cal.setLocation("New Location");
    client.updateCalendar(cal);
}

Удалить конкретный календарь

Для удаления конкретного календаря необходимо получить список всех календарей клиента, а затем удалить нужный. listCalendars возвращает список ExtendedCalendar который содержит календари Gmail. Следующий фрагмент кода показывает, как удалить конкретный календарь.

try (IGmailClient client = GmailClient.getInstance(accessToken, email)) {
    // Access and delete calendar with summary starting from "Calendar summary"
    String summary = "Calendar summary";

    // Get calendars list
    ExtendedCalendar[] lst = client.listCalendars();

    for (ExtendedCalendar extCal : lst) {
        // Delete selected calendars
        if (extCal.getSummary().startsWith(summary))
            client.deleteCalendar(extCal.getId());
    }
}

Работа с контролем доступа к календарю

Aspose.Email предоставляет полный контроль над доступом к элементам календаря. listAccessRules функция предоставлена в IGmailClient которая возвращает список AccessControlRule. Информацию о отдельном правиле можно получить, изменить и сохранить обратно для календаря клиента. IGmailClient содержит следующие функции для управления правилами контроля доступа.

listAccessRules Эта функция предоставляет список AccessControlRule
createAccessRule Эта функция создает новое правило доступа для календаря.
updateAccessRule Эта функция используется для обновления правила доступа.
fetchAccessRule Можно использовать для получения конкретного правила доступа к календарю клиента
deleteAccessRule Эта функция используется для удаления правила доступа.

Следующий фрагмент кода показывает, как используются функции для управления правилами доступа:

try (IGmailClient client = GmailClient.getInstance(accessToken, email)) {
    // Retrieve list of calendars for the current client
    ExtendedCalendar[] calendarList = client.listCalendars();

    // Get first calendar id and retrieve list of AccessControlRule for the first calendar
    String calendarId = calendarList[0].getId();
    AccessControlRule[] roles1 = client.listAccessRules(calendarId);

    // Create a local access control rule and Set rule properties
    AccessControlRule rule = new AccessControlRule();
    rule.setRole(AccessRole.reader);
    rule.setScope(new AclScope(AclScopeType.user, email2));

    // Insert new rule for the calendar. It returns the newly created rule
    AccessControlRule createdRule = client.createAccessRule(calendarId, rule);

    // Get list of rules
    AccessControlRule[] roles2 = client.listAccessRules(calendarId);

    // Current list length should be 1 more than the earlier one
    if (roles1.length + 1 == roles2.length) {
        System.out.println("List lengths are ok");
    } else {
        System.out.println("List lengths are not ok");
        return;
    }

    // Change rule and Update the rule for the selected calendar
    createdRule.setRole(AccessRole.writer);
    AccessControlRule updatedRule = client.updateAccessRule(calendarId, createdRule);

    // Retrieve individaul rule against a calendar
    AccessControlRule fetchedRule = client.fetchAccessRule(calendarId, createdRule.getId());

    // Delete particular rule against a given calendar and Retrieve the all rules list for the same calendar
    client.deleteAccessRule(calendarId, createdRule.getId());
    AccessControlRule[] roles3 = client.listAccessRules(calendarId);

    // Check that current rules list length should be equal to the original list length before adding and deleting the rule
    if (roles1.length == roles3.length) {
        System.out.println("List lengths are same");
    } else {
        System.out.println("List lengths are not equal");
        return;
    }
}

Работа с настройками клиента и информацией о цвете

Aspose.Email поддерживает доступ к настройкам клиента с помощью IGmailClient.getSettings. Возвращает список настроек, как указано ниже:

dateFieldOrder
displayAllTimezones
hideInvitations
format24HourTime
defaultCalendarMode
defaultEventLength
locale
remindOnRespondedEventsOnly
alternateCalendar
userLocation
hideWeekends
showDeclinedEvents
weekStart
weather
customCalendarMode
timezoneLabel
timezone
useKeyboardShortcuts
country

Аналогично информацию о цвете для клиентов можно получить, используя IGmailClient.getColors. Этот объект информации о цвете возвращает список цветов переднего плана, цветов фона и дату и время обновления.

Доступ к настройкам клиента

Следующий фрагмент кода показывает, как используются функции для доступа к настройкам клиента:

try (IGmailClient client = GmailClient.getInstance(accessToken, email)) {
    // Retrieve client settings
    Dictionary<String, String> settings = client.getSettings();
    if (settings.size() < 1) {
        System.out.println("No settings are available.");
        return;
    }

    // Traverse the settings list
    for (KeyValuePair<String, String> pair : settings) {
        // Get the setting value and test if settings are ok
        String value = client.getSetting(pair.getKey());
        if (pair.getValue().equals(value)) {
            System.out.println("Key = " + pair.getKey() + ", Value = " + pair.getValue());
        } else {
            System.out.println("Settings could not be retrieved");
        }
    }
}

Получить информацию о цвете

Следующий фрагмент кода показывает, как используются функции для доступа к настройкам цветов клиента.

try (IGmailClient client = GmailClient.getInstance(accessToken, email)) {
    ColorsInfo colors = client.getColors();
    Dictionary<String, Colors> palettes = colors.getCalendar();

    // Traverse the settings list
    for (KeyValuePair<String, Colors> pair : palettes) {
        System.out.println("Key = " + pair.getKey() + ", Color = " + pair.getValue());
    }
    System.out.println("Update Date = " + colors.getUpdated());
}

Работа с встречами

Aspose.Email предоставляет возможности для работы с Встречи в календарях Google. Ниже приведен список задач, которые можно выполнять с встречами в Google Календаре:

Добавить встречи - createAppointment, importAppointment
Получить список встреч - listAppointments
Получить конкретную встречу - fetchAppointment, listAppointmentInstances
Обновить встречу - updateAppointment
Переместить встречу из одного календаря в другой - moveAppointment
Удалить встречу - deleteAppointment

Добавление встречи

Следующий пример кода демонстрирует возможность добавления встречи в календарь. В этом примере выполнены следующие шаги:

Создать и вставить календарь.
Получить список встреч из нового календаря.
Создать встречу.
Вставить встречу.

try (IGmailClient client = GmailClient.getInstance(accessToken, email)) {
    // Create local calendar
    Calendar calendar1 = new Calendar("Summary", null, null, "Europe/Kiev");

    // Insert calendar and get id of inserted calendar and Get back calendar using an id
    String id = client.createCalendar(calendar1);
    Calendar cal1 = client.fetchCalendar(id);
    String calendarId1 = cal1.getId();

    try {
        // Retrieve list of appointments from the first calendar
        Appointment[] appointments = client.listAppointments(calendarId1);
        if (appointments.length > 0) {
            System.out.println("Wrong number of appointments");
            return;
        }

        // Get current time and Calculate time after an hour from now
        java.util.Calendar c = java.util.Calendar.getInstance();
        Date startDate = c.getTime();
        c.add(java.util.Calendar.HOUR_OF_DAY, 1);
        Date endDate = c.getTime();

        // Initialize a mail address collection and set attendees mail address
        MailAddressCollection attendees = new MailAddressCollection();
        attendees.add("User1.EMail@domain.com");
        attendees.add("User3.EMail@domain.com");

        // Create an appointment with above attendees
        Appointment app1 = new Appointment("Location", startDate, endDate, MailAddress.to_MailAddress(email2), attendees);

        // Set appointment summary, description, start/end time zone
        app1.setSummary("New Summary");
        app1.setDescription("New Description");
        app1.setStartTimeZone("Europe/Kiev");
        app1.setEndTimeZone("Europe/Kiev");

        // Insert appointment in the first calendar inserted above and get back inserted appointment
        Appointment app2 = client.createAppointment(calendarId1, app1);

        // Retrieve appointment using unique id
        Appointment app3 = client.fetchAppointment(calendarId1, app2.getUniqueId());
    } catch (Exception ex) {
        System.err.println(ex);
    }
    
}

Получение и обновление встречи

Здесь демонстрируются получение и обновление календаря следующим образом:

Получить конкретную встречу.
Изменить встречу.
Обновить встречу в календаре.

Предполагается, что календарь с id "calendarId" и уникальный id встречи "AppointmentUniqueId" уже получены. Следующий фрагмент кода показывает, как получить и обновить встречу.

try (IGmailClient client = GmailClient.getInstance(accessToken, email)) {
    String calendarId = client.listCalendars()[0].getId();
    String AppointmentUniqueId = client.listAppointments(calendarId)[0].getUniqueId();

    // Retrieve Appointment
    Appointment app3 = client.fetchAppointment(calendarId, AppointmentUniqueId);
    // Change the appointment information
    app3.setSummary("New Summary");
    app3.setDescription("New Description");
    app3.setLocation("New Location");
    app3.setFlags(AppointmentFlags.AllDayEvent);
    java.util.Calendar c = java.util.Calendar.getInstance();
    c.add(java.util.Calendar.HOUR_OF_DAY, 2);
    app3.setStartDate(c.getTime());
    c.add(java.util.Calendar.HOUR_OF_DAY, 1);
    app3.setEndDate(c.getTime());
    app3.setStartTimeZone("Europe/Kiev");
    app3.setEndTimeZone("Europe/Kiev");
    // Update the appointment and get back updated appointment
    Appointment app4 = client.updateAppointment(calendarId, app3);
}

Перемещение и удаление встречи

Appointment может быть перемещено путем указания исходного календаря, целевого календаря и уникального идентификатора встречи в исходном календаре. Следующий фрагмент кода показывает, как переместить и удалить встречу.

try (IGmailClient client = GmailClient.getInstance(accessToken, email)) {
    String SourceCalendarId = client.listCalendars()[0].getId();
    String DestinationCalendarId = client.listCalendars()[1].getId();
    String TargetAppUniqueId = client.listAppointments(SourceCalendarId)[0].getUniqueId();

    // Retrieve the list of appointments in the destination calendar before moving the appointment
    Appointment[] appointments = client.listAppointments(DestinationCalendarId);
    System.out.println("Before moving count = " + appointments.length);
    Appointment Movedapp = client.moveAppointment(SourceCalendarId, DestinationCalendarId, TargetAppUniqueId);

    // Retrieve the list of appointments in the destination calendar after moving the appointment
    appointments = client.listAppointments(DestinationCalendarId);
    System.out.println("After moving count = " + appointments.length);

    // Delete particular appointment from a calendar using unique id
    client.deleteAppointment(DestinationCalendarId, Movedapp.getUniqueId());

    // Retrieve the list of appointments. It should be one less than the earlier appointments in the destination calendar
    appointments = client.listAppointments(DestinationCalendarId);
    System.out.println("After deleting count = " + appointments.length);
}

Функции утилиты Gmail Работа с контактами Gmail