Creación de una serie periódica mediante EWS en Exchange
Obtenga información sobre cómo crear reuniones periódicas mediante la API administrada de EWS o EWS en Exchange.
La creación de una cita o reunión periódica no es tan diferente de crear una cita o reunión de instancia única. Solo tiene que asignar valores a algunas propiedades adicionales relacionadas con la periodicidad. Se establecen en el objeto Recurrence de un objeto ExchangeService.Appointment (si usa la API administrada de EWS) o en el elemento secundario Recurrence de un elemento CalendarItem (si usa EWS). Una cosa que hay que tener en cuenta al crear una reunión periódica, en lugar de una reunión de instancia única, es que el elemento de calendario que se crea es el patrón periódico para una serie. Una serie de propiedades se establecen solo en un patrón periódico; estas propiedades pueden ayudarle a buscar, modificar o eliminar instancias individuales de una serie. Por este motivo, puede ser útil realizar un seguimiento del identificador del patrón periódico al crear una serie periódica.
Tabla 1. Propiedades establecidas en elementos de calendario maestro periódicos
| Propiedad o clase de API administrada de EWS | Elemento XML de EWS | Descripción |
|---|---|---|
| Recurrence (clase) La clase Recurrence es la clase base de una clase de patrón derivada, ya sea IntervalPattern, RelativeYearlyPattern o YearlyPattern. |
Recurrence (RecurrenceType) |
Contiene información relacionada con la periodicidad, incluido el patrón de periodicidad (diario, semanal, mensual, etc.), la fecha de inicio y finalización, el número de repeticiones, etc. |
| FirstOccurrence (propiedad) |
FirstOccurrence |
Contiene las horas de inicio y finalización y el identificador de elemento de la primera reunión de una serie. |
| LastOccurrence (propiedad) |
LastOccurrence |
Contiene las horas de inicio y finalización y el identificador de elemento de la última reunión de una serie. |
| ModifiedOccurrences (propiedad) |
ModifiedOccurrences |
Contiene el conjunto de todas las reuniones de la serie que se han modificado a partir del patrón de periodicidad original. |
| DeletedOccurrences (propiedad) |
DeletedOccurrences |
Contiene el conjunto de todas las reuniones de la serie que se han eliminado del patrón de periodicidad original. |
Dado que las reuniones son básicamente citas que incluyen asistentes, los ejemplos de código de este artículo muestran cómo crear reuniones periódicas. Si desea crear una cita periódica, puede modificar los ejemplos quitando el código relacionado con los asistentes.
Creación de una reunión periódica mediante la API administrada de EWS
En el ejemplo de código siguiente se muestra cómo crear una reunión periódica. En primer lugar, asigne valores a las propiedades de un objeto Appointment que se usa para crear una reunión y, a continuación, use el método Save para guardar la serie periódica en la carpeta de calendario y enviar solicitudes de reunión a los asistentes. Por último, use el método Appointment.Bind para examinar los valores establecidos en el patrón periódico para la serie periódica que acaba de crear.
En este ejemplo se supone que se ha autenticado en un servidor de Exchange y ha adquirido un objeto ExchangeService denominado servicio. El método de este ejemplo devuelve el identificador de elemento del patrón periódico de la serie periódica.
public static ItemId CreateARecurringMeeting(ExchangeService service)
{ Appointment recurrMeeting = new Appointment(service);
// Set the properties you need to create a meeting.
recurrMeeting.Subject = "Weekly Update Meeting";
recurrMeeting.Body = "Come hear about how the project is coming along!";
recurrMeeting.Start = DateTime.Now.AddDays(1);
recurrMeeting.End = recurrMeeting.Start.AddHours(1);
recurrMeeting.Location = "Contoso Main Gallery";
recurrMeeting.RequiredAttendees.Add("Mack@contoso.com");
recurrMeeting.RequiredAttendees.Add("Sadie@contoso.com");
recurrMeeting.RequiredAttendees.Add("Magdalena@contoso.com"); recurrMeeting.ReminderMinutesBeforeStart = 30;
DayOfTheWeek[] dow = new DayOfTheWeek[] { (DayOfTheWeek)recurrMeeting.Start.DayOfWeek };
// The following are the recurrence-specific properties for the meeting.
recurrMeeting.Recurrence = new Recurrence.WeeklyPattern(recurrMeeting.Start.Date, 1, dow);
recurrMeeting.Recurrence.StartDate = recurrMeeting.Start.Date;
recurrMeeting.Recurrence.NumberOfOccurrences = 10;
// This method results in in a CreateItem call to EWS.
recurrMeeting.Save(SendInvitationsMode.SendToAllAndSaveCopy);
// Retrieve the meeting subject and the properties that are set on a recurring master when a recurring series is created.
recurrMeeting = Appointment.Bind(service, recurrMeeting.Id, new PropertySet(AppointmentSchema.Subject,
AppointmentSchema.AppointmentType,
AppointmentSchema.Recurrence,
AppointmentSchema.FirstOccurrence,
AppointmentSchema.LastOccurrence,
AppointmentSchema.ModifiedOccurrences,
AppointmentSchema.DeletedOccurrences));
// Print out the recurring master properties.
Console.WriteLine("\nAppointment created: " + recurrMeeting.Subject);
Console.WriteLine("Appointment Type: {0}\n", recurrMeeting.AppointmentType);
Console.WriteLine("These property values are always null unless the item is a recurring master:\n");
Console.WriteLine("\tRecurrence pattern: {0}", recurrMeeting.Recurrence.ToString());
Console.WriteLine("\tRecurring series start Date: {0}", recurrMeeting.Recurrence.StartDate.ToString());
Console.WriteLine("\tRecurring series end Date: {0}",
recurrMeeting.Recurrence.EndDate == null ? "Null" : recurrMeeting.Recurrence.EndDate.ToString());
Console.WriteLine("\tHas end: {0}", recurrMeeting.Recurrence.HasEnd.ToString());
Console.WriteLine("\tNumber of occurrances: {0}", recurrMeeting.Recurrence.NumberOfOccurrences);
Console.WriteLine("\tLast 24 characters of the first occurrence's item ID:\t {0}",
recurrMeeting.FirstOccurrence.ItemId.ToString().Substring(144));
Console.WriteLine("\tLast 24 characters of the last occurrence's item ID:\t {0}",
recurrMeeting.LastOccurrence.ItemId.ToString().Substring(144));
Console.WriteLine("\tModified Occurrences: {0}",
(recurrMeeting.ModifiedOccurrences == null ? "Null" : recurrMeeting.ModifiedOccurrences.Count.ToString()));
Console.WriteLine("\tDeleted Occurrences: {0}",
recurrMeeting.DeletedOccurrences == null ? "Null" : recurrMeeting.ModifiedOccurrences.Count.ToString());
// Return the ID of the recurring master.
return recurrMeeting.Id;
}
Creación de una reunión periódica mediante EWS
El XML de solicitud y respuesta de los ejemplos siguientes corresponde a las llamadas realizadas para crear una reunión periódica mediante la API administrada de EWS. Tenga en cuenta que, aparte de establecer valores específicos de periodicidad en el elemento Recurrence , la solicitud es básicamente la misma que la que usaría para crear una cita de instancia única. En el ejemplo siguiente se muestra el XML de solicitud cuando se usa la operación CreateItem para crear una reunión.
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:m="http://schemas.microsoft.com/exchange/services/2006/messages"
xmlns:t="http://schemas.microsoft.com/exchange/services/2006/types"
xmlns:soap="https://schemas.xmlsoap.org/soap/envelope/">
<soap:Header>
<t:RequestServerVersion Version="Exchange2010" />
<t:TimeZoneContext>
<t:TimeZoneDefinition Name="(UTC-08:00) Pacific Time (US &amp; Canada)" Id="Pacific Standard Time">
<t:Periods>
<t:Period Bias="P0DT8H0M0.0S" Name="Standard" Id="Std" />
<t:Period Bias="P0DT7H0M0.0S" Name="Daylight" Id="Dlt/1" />
<t:Period Bias="P0DT7H0M0.0S" Name="Daylight" Id="Dlt/2007" />
</t:Periods>
<t:TransitionsGroups>
<t:TransitionsGroup Id="0">
<t:RecurringDayTransition>
<t:To Kind="Period">Dlt/1</t:To>
<t:TimeOffset>P0DT2H0M0.0S</t:TimeOffset>
<t:Month>4</t:Month>
<t:DayOfWeek>Sunday</t:DayOfWeek>
<t:Occurrence>1</t:Occurrence>
</t:RecurringDayTransition>
<t:RecurringDayTransition>
<t:To Kind="Period">Std</t:To>
<t:TimeOffset>P0DT2H0M0.0S</t:TimeOffset>
<t:Month>10</t:Month>
<t:DayOfWeek>Sunday</t:DayOfWeek>
<t:Occurrence>-1</t:Occurrence>
</t:RecurringDayTransition>
</t:TransitionsGroup>
<t:TransitionsGroup Id="1">
<t:RecurringDayTransition>
<t:To Kind="Period">Dlt/2007</t:To>
<t:TimeOffset>P0DT2H0M0.0S</t:TimeOffset>
<t:Month>3</t:Month>
<t:DayOfWeek>Sunday</t:DayOfWeek>
<t:Occurrence>2</t:Occurrence>
</t:RecurringDayTransition>
<t:RecurringDayTransition>
<t:To Kind="Period">Std</t:To>
<t:TimeOffset>P0DT2H0M0.0S</t:TimeOffset>
<t:Month>11</t:Month>
<t:DayOfWeek>Sunday</t:DayOfWeek>
<t:Occurrence>1</t:Occurrence>
</t:RecurringDayTransition>
</t:TransitionsGroup>
</t:TransitionsGroups>
<t:Transitions>
<t:Transition>
<t:To Kind="Group">0</t:To>
</t:Transition>
<t:AbsoluteDateTransition>
<t:To Kind="Group">1</t:To>
<t:DateTime>2007-01-01T08:00:00.000Z</t:DateTime>
</t:AbsoluteDateTransition>
</t:Transitions>
</t:TimeZoneDefinition>
</t:TimeZoneContext>
</soap:Header>
<soap:Body>
<m:CreateItem SendMeetingInvitations="SendToAllAndSaveCopy">
<m:Items>
<t:CalendarItem>
<t:Subject>Weekly Update Meeting</t:Subject>
<t:Body BodyType="HTML">Come hear about how the Organized Observational Paradigm SkyNet project is coming along!</t:Body>
<t:ReminderMinutesBeforeStart>30</t:ReminderMinutesBeforeStart>
<t:Start>2014-03-08T13:21:32.868-08:00</t:Start>
<t:End>2014-03-08T14:21:32.868-08:00</t:End>
<t:Location>Contoso Main Gallery</t:Location>
<t:RequiredAttendees>
<t:Attendee>
<t:Mailbox>
<t:EmailAddress>Mack@contoso.com</t:EmailAddress>
</t:Mailbox>
</t:Attendee>
<t:Attendee>
<t:Mailbox>
<t:EmailAddress>Sadie@contoso.com</t:EmailAddress>
</t:Mailbox>
</t:Attendee>
<t:Attendee>
<t:Mailbox>
<t:EmailAddress>Magdalena@contoso.com</t:EmailAddress>
</t:Mailbox>
</t:Attendee>
</t:RequiredAttendees>
<t:Recurrence>
<t:WeeklyRecurrence>
<t:Interval>1</t:Interval>
<t:DaysOfWeek>Saturday</t:DaysOfWeek>
</t:WeeklyRecurrence>
<t:NumberedRecurrence>
<t:StartDate>2014-03-08-08:00</t:StartDate>
<t:NumberOfOccurrences>10</t:NumberOfOccurrences>
</t:NumberedRecurrence>
</t:Recurrence>
</t:CalendarItem>
</m:Items>
</m:CreateItem>
</soap:Body>
</soap:Envelope>
En el ejemplo siguiente se muestra el XML de respuesta devuelto por la operación CreateItem.
Los atributos itemId y ChangeKey se acortan para mejorar la legibilidad.
<?xml version="1.0" encoding="utf-8"?>
<s:Envelope xmlns:s="https://schemas.xmlsoap.org/soap/envelope/">
<s:Header>
<h:ServerVersionInfo MajorVersion="15" MinorVersion="0" MajorBuildNumber="893" MinorBuildNumber="10"
Version="V2_10" xmlns:h="http://schemas.microsoft.com/exchange/services/2006/types"
xmlns="http://schemas.microsoft.com/exchange/services/2006/types"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" />
</s:Header>
<s:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<m:CreateItemResponse xmlns:m="http://schemas.microsoft.com/exchange/services/2006/messages"
xmlns:t="http://schemas.microsoft.com/exchange/services/2006/types">
<m:ResponseMessages>
<m:CreateItemResponseMessage ResponseClass="Success">
<m:ResponseCode>NoError</m:ResponseCode>
<m:Items>
<t:CalendarItem>
<t:ItemId Id="AAMkAD" ChangeKey="DwAAAB" />
</t:CalendarItem>
</m:Items>
</m:CreateItemResponseMessage>
</m:ResponseMessages>
</m:CreateItemResponse>
</s:Body>
</s:Envelope>
En el ejemplo siguiente se muestra el XML de solicitud que se genera al usar la operación GetItem y itemId para la serie que creó, y las propiedades de solicitud solo se establecen en un patrón periódico para confirmar que el ItemId devuelto por el servidor al crear una serie periódica es para un patrón periódico.
Los atributos itemId y ChangeKey se acortan para mejorar la legibilidad.
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:m="http://schemas.microsoft.com/exchange/services/2006/messages"
xmlns:t="http://schemas.microsoft.com/exchange/services/2006/types"
xmlns:soap="https://schemas.xmlsoap.org/soap/envelope/">
<soap:Header>
<t:RequestServerVersion Version="Exchange2010" />
</soap:Header>
<soap:Body>
<m:GetItem>
<m:ItemShape>
<t:BaseShape>IdOnly</t:BaseShape>
<t:AdditionalProperties>
<t:FieldURI FieldURI="item:Subject" />
<t:FieldURI FieldURI="calendar:CalendarItemType" />
<t:FieldURI FieldURI="calendar:Recurrence" />
<t:FieldURI FieldURI="calendar:FirstOccurrence" />
<t:FieldURI FieldURI="calendar:LastOccurrence" />
<t:FieldURI FieldURI="calendar:ModifiedOccurrences" />
<t:FieldURI FieldURI="calendar:DeletedOccurrences" />
</t:AdditionalProperties>
</m:ItemShape>
<m:ItemIds>
<t:ItemId Id="AAMkAD" ChangeKey="DwAAAB" />
</m:ItemIds>
</m:GetItem>
</soap:Body>
</soap:Envelope>
En el ejemplo siguiente se muestra el XML de respuesta devuelto por la operación GetItem .
Los atributos itemId y ChangeKey se acortan para mejorar la legibilidad.
<?xml version="1.0" encoding="utf-8"?>
<s:Envelope xmlns:s="https://schemas.xmlsoap.org/soap/envelope/">
<s:Header>
<h:ServerVersionInfo MajorVersion="15" MinorVersion="0" MajorBuildNumber="893" MinorBuildNumber="10"
Version="V2_10" xmlns:h="http://schemas.microsoft.com/exchange/services/2006/types"
xmlns="http://schemas.microsoft.com/exchange/services/2006/types"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" />
</s:Header>
<s:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<m:GetItemResponse xmlns:m="http://schemas.microsoft.com/exchange/services/2006/messages"
xmlns:t="http://schemas.microsoft.com/exchange/services/2006/types">
<m:ResponseMessages>
<m:GetItemResponseMessage ResponseClass="Success">
<m:ResponseCode>NoError</m:ResponseCode>
<m:Items>
<t:CalendarItem>
<t:ItemId Id="AAMkAD" ChangeKey="DwAAAB" />
<t:Subject>Weekly Update Meeting</t:Subject>
<t:CalendarItemType>RecurringMaster</t:CalendarItemType>
<t:Recurrence>
<t:WeeklyRecurrence>
<t:Interval>1</t:Interval>
<t:DaysOfWeek>Saturday</t:DaysOfWeek>
</t:WeeklyRecurrence>
<t:NumberedRecurrence>
<t:StartDate>2014-03-08-08:00</t:StartDate>
<t:NumberOfOccurrences>10</t:NumberOfOccurrences>
</t:NumberedRecurrence>
</t:Recurrence>
<t:FirstOccurrence>
<t:ItemId Id="AAMkAD" ChangeKey="DwAAABY" />
<t:Start>2014-03-08T21:21:00Z</t:Start>
<t:End>2014-03-08T22:21:00Z</t:End>
<t:OriginalStart>2014-03-08T21:21:00Z</t:OriginalStart>
</t:FirstOccurrence>
<t:LastOccurrence>
<t:ItemId Id="AAMkAD" ChangeKey="DwAAABY" />
<t:Start>2014-05-10T20:21:00Z</t:Start>
<t:End>2014-05-10T21:21:00Z</t:End>
<t:OriginalStart>2014-05-10T20:21:00Z</t:OriginalStart>
</t:LastOccurrence>
</t:CalendarItem>
</m:Items>
</m:GetItemResponseMessage>
</m:ResponseMessages>
</m:GetItemResponse>
</s:Body>
</s:Envelope>