Trabajando con Calendarios de Gmail

Agregar, Editar y Eliminar un Calendario

Aspose.Email permite a las aplicaciones gestionar los calendarios de Gmail usando IGmailClient que proporciona funciones como agregar, eliminar y actualizar calendarios de Gmail. Esta clase cliente devuelve una lista de objetos de tipo ExtendedCalendar que contienen información sobre los elementos del calendario de Gmail. IGmailClient la clase expone las siguientes funciones para calendarios:

createCalendar Para insertar un nuevo calendario
listCalendars

Obtener la lista de todos los calendarios de un cliente

deleteCalendar Puede usarse para eliminar un calendario
fetchCalendar Puede usarse para obtener un calendario concreto de un cliente
updateCalendar Esta función se usa para volver a insertar un calendario modificado de un cliente

Para acceder a los calendarios, GoogleTestUser se inicializa usando credenciales de una cuenta de Gmail. GoogleOAuthHelper se utiliza para obtener el token de acceso del usuario, que luego se usa para inicializar IGmailClient.

Insertar, Obtener y Actualizar

Para insertar un calendario, inicialice un Calendar objeto tipo e insertarlo usando createCalendar función. createCalendar devuelve el id del calendario recién insertado. Este id puede usarse para obtener el calendario del servidor. El siguiente fragmento de código muestra cómo insertar, obtener y actualizar un calendario.

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);
}

Eliminar Calendario Particular

Para eliminar un calendario concreto, necesitamos obtener la lista de todos los calendarios de un cliente y luego eliminar según sea necesario. listCalendars devuelve la lista de ExtendedCalendar que contiene calendarios de Gmail. El siguiente fragmento de código muestra cómo eliminar un calendario concreto.

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());
    }
}

Trabajando con el Control de Acceso al Calendario

Aspose.Email brinda control total sobre el control de acceso a los elementos del calendario. listAccessRules función está expuesta por IGmailClient que devuelve una lista de AccessControlRule. La información individual de la regla puede ser recuperada, modificada y guardada de nuevo para el calendario de un cliente. IGmailClient contiene las siguientes funciones para gestionar las reglas de control de acceso.

listAccessRules Esta función proporciona una lista de AccessControlRule
createAccessRule Esta función crea una nueva regla de acceso para un calendario.
updateAccessRule Esta función se utiliza para actualizar una regla de acceso.
fetchAccessRule Puede usarse para obtener una regla de acceso particular para el calendario de un cliente
deleteAccessRule Esta función se utiliza para eliminar una regla de acceso.

El siguiente fragmento de código muestra cómo se usan las funciones para gestionar las reglas de acceso:

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;
    }
}

Trabajando con Configuración del Cliente e Información de Color

Aspose.Email permite acceder a la configuración del Cliente mediante IGmailClient.getSettings. Devuelve la lista de configuraciones como se muestra a continuación:

dateFieldOrder
displayAllTimezones
hideInvitations
format24HourTime
defaultCalendarMode
defaultEventLength
locale
remindOnRespondedEventsOnly
alternateCalendar
ubicaciónUsuario
hideWeekends
showDeclinedEvents
inicioDeSemana
clima
customCalendarMode
timezoneLabel
zona horaria
useKeyboardShortcuts
país

De manera similar, la información de color para clientes también se puede obtener usando IGmailClient.getColors. Este objeto de información de color devuelve la lista de colores de primer plano, colores de fondo y la fecha y hora de actualización.

Acceder a la Configuración del Cliente

El siguiente fragmento de código muestra cómo se usan las funciones para acceder a la configuración del cliente:

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");
        }
    }
}

Acceder a la Información de Color

El siguiente fragmento de código muestra cómo se usan las funciones para acceder a la configuración de colores del cliente.

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());
}

Trabajando con Citas

Aspose.Email proporciona funciones para trabajar con Citas en calendarios de Google. A continuación se muestra la lista de tareas que se pueden realizar con citas en Google Calendar:

Agregar citas - createAppointment, importAppointment
Recuperar lista de citas - listAppointments
Recuperar una cita particular - fetchAppointment, listAppointmentInstances
Actualizar una cita - updateAppointment
Mover cita de un calendario a otro - moveAppointment
Eliminar cita - deleteAppointment

Añadiendo una cita

El siguiente ejemplo de código muestra la funcionalidad de añadir una cita en un calendario. En este ejemplo se siguen los pasos siguientes:

Crear e insertar un calendario.
Recuperar la lista de citas de un nuevo calendario.
Crear una cita.
Insertar cita.

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);
    }
    
}

Recuperar y actualizar cita

Aquí se demuestran la recuperación y actualización del calendario de la siguiente manera:

Recuperar una cita particular.
Modificar la cita.
Actualizar la cita en el calendario.

Se asume que ya se han extraído un calendario con id "calendarId" y el id único de la cita "AppointmentUniqueId". El siguiente fragmento de código muestra cómo recuperar y actualizar la cita.

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);
}

Mover y eliminar cita

Appointment puede ser movido proporcionando el calendario de origen, el calendario de destino y el id único de la cita en el calendario de origen. El siguiente fragmento de código muestra cómo mover y eliminar la cita.

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);
}

Funciones de Utilidad de Gmail Trabajar con contactos de Gmail