在 Exchange 中使用 EWS 访问定期系列

项目
03/29/2023

了解如何使用 Exchange 中的 EWS 托管 API 或 EWS 访问定期系列中的日历项目。

定期约会或会议系列由定期主节点、一系列中根据设置模式重复的多个事件以及已更改和已删除的一组事件组成。可以使用 EWS 托管 API 或 EWS 访问定期系列中的日历项目。这使你能够：

检查与项目 ID 关联的日历项是否为定期主控形状、系列中的事件或系列异常。
在日历文件夹中搜索定期约会。
获取相关的定期日历项
循环访问系列中的事件、事件异常或删除事件。

使用 EWS 托管 API 获取定期日历项的集合

如果要检索约会集合，可以使用 ExchangeService.FindAppointments 方法检索给定开始和结束日期之间的所有约会，然后将约会类型为 “出现” 或 “异常” 的所有日历项目添加到集合，如以下示例所示。

此示例假定已对 Exchange 服务器进行了身份验证，并且已获取名为 service 的 ExchangeService 对象。

public static Collection<Appointment> FindRecurringCalendarItems(ExchangeService service, 
                                                                    DateTime startSearchDate, 
                                                                    DateTime endSearchDate)
{
    // Instantiate a collection to hold occurrences and exception calendar items.
    Collection<Appointment> foundAppointments = new Collection<Appointment>();
    // Create a calendar view to search the calendar folder and specify the properties to return.
    CalendarView calView = new CalendarView(startSearchDate, endSearchDate);
    calView.PropertySet = new PropertySet(BasePropertySet.IdOnly, 
                                            AppointmentSchema.Subject, 
                                            AppointmentSchema.Start, 
                                            AppointmentSchema.IsRecurring, 
                                            AppointmentSchema.AppointmentType);
    // Retrieve a collection of calendar items.
    FindItemsResults<Appointment> findResults = service.FindAppointments(WellKnownFolderName.Calendar, calView);
    // Add all calendar items in your view that are occurrences or exceptions to your collection.
    foreach (Appointment appt in findResults.Items)
    {
        if (appt.AppointmentType == AppointmentType.Occurrence || appt.AppointmentType == AppointmentType.Exception)
        {
            foundAppointments.Add(appt);
        }
        else
        {
            Console.WriteLine("Discarding calendar item of type {0}.", appt.AppointmentType);
        }
    }
    return foundAppointments;
}

请注意，定期主日历项目不会在调用 FindAppointments 时返回。如果要检索定期母版，或者想要检索日历项的更常规方法，则需要使用 ExchangeService.FindItems。然后，可以使用搜索筛选器仅检索开始日期大于或等于所选日期的项目，并使用项目视图来限制要返回的项目数。请注意，在搜索中找不到开始日期早于开始日期的定期主控形状，即使在此范围内出现事件也是如此。

此示例假定已对 Exchange 服务器进行了身份验证，并且已获取名为 service 的 ExchangeService 对象。

public static Collection<Appointment> FindCalendarItemsByAppointmentType(ExchangeService service, 
                                                                         AppointmentType myAppointmentType, 
                                                                         DateTime startSearchDate)
{
    Collection<Appointment> foundAppointments = new Collection<Appointment>();
    // Create a search filter based on the start search date.
    SearchFilter.SearchFilterCollection searchFilter = new SearchFilter.SearchFilterCollection();
    searchFilter.Add(new SearchFilter.IsGreaterThanOrEqualTo(AppointmentSchema.Start, startSearchDate));
    // Create an item view to specify which properties to return.
    ItemView view = new ItemView(20);
    view.PropertySet = new PropertySet(BasePropertySet.IdOnly, 
                                       AppointmentSchema.Subject, 
                                       AppointmentSchema.Start, 
                                       AppointmentSchema.AppointmentType,
                                       AppointmentSchema.IsRecurring);
    // Get the appointment items from the server with the properties we specified.
    FindItemsResults<Item> findResults = service.FindItems(WellKnownFolderName.Calendar, searchFilter, view);
    // Add each of the appointments of the type you want to the collection.
    foreach (Item item in findResults.Items)
    {
        Appointment appt = item as Appointment;
        if (appt.AppointmentType == myAppointmentType)
        {
            foundAppointments.Add(appt);
        }
    }
    return foundAppointments;
}

有时你有一个谜题，但要解决它，你需要其余部分。如果你有定期日历项的项目 ID，则可以使用多个 EWS 托管 API 属性或方法之一获取所需的其他部分。

表 1. 用于获取相关重复日历项的 EWS 托管 API 属性或方法

如果你有的项目 ID...	你可以获取...	通过使用...
定期主日历项	系列中的第一个匹配项系列中的最后一个匹配项序列的异常序列中已删除的约会任何事件 (给定其索引)	Appointment.FirstOccurrence 属性 Appointment.LastOccurrence 属性 Appointment.ModifiedOccurrences 属性 Appointment.DeletedOccurrences 属性 Appointment.BindToOccurrence 方法
序列中的单个匹配项	定期主控服务器	Appointment.BindToRecurringMaster 方法
) 约会对象 (任何日历项	约会类型枚举值	Appointment.AppointmentType 属性

下面的代码示例演示如何获取定期主控形状、序列中的第一个或最后一个匹配项或给定索引的匹配项。

此示例假定已对 Exchange 服务器进行了身份验证，并且已获取名为 service 的 ExchangeService 对象。

public static void GetRelatedRecurrenceCalendarItems(ExchangeService service, ItemId itemId)
{
    Appointment calendarItem = Appointment.Bind(service, itemId, new PropertySet(AppointmentSchema.AppointmentType));
    Appointment recurrMaster = new Appointment(service);
    PropertySet props = new PropertySet(AppointmentSchema.AppointmentType,
                                        AppointmentSchema.Subject,
                                        AppointmentSchema.FirstOccurrence,
                                        AppointmentSchema.LastOccurrence,
                                        AppointmentSchema.ModifiedOccurrences,
                                        AppointmentSchema.DeletedOccurrences);
    // If the item ID is not for a recurring master, retrieve the recurring master for the series.
    switch (calendarItem.AppointmentType)
    {
        // Calendar item is a recurring master so use Appointment.Bind
        case AppointmentType.RecurringMaster:
            recurrMaster = Appointment.Bind(service, itemId, props);
            break;
        // The calendar item is a single instance meeting, so there are no instances to modify or delete.
        case AppointmentType.Single:
            Console.WriteLine("Item id must reference a calendar item that is part of a recurring series.");
            return;
        // The calendar item is an occurrence in the series, so use BindToRecurringMaster.
        case AppointmentType.Occurrence:
            recurrMaster = Appointment.BindToRecurringMaster(service, itemId, props);
            break;
        // The calendar item is an exception to the series, so use BindToRecurringMaster.                
        case AppointmentType.Exception:
            recurrMaster = Appointment.BindToRecurringMaster(service, itemId, props);
            break;
    }
    // View the first occurrence, last occurrence, and number of modified and deleted occurrences associated with the recurring master.
    Console.WriteLine("Information for the {0} recurring series:", recurrMaster.Subject);
    Console.WriteLine("The start time for the first appointment with id \t{0} was on \t{1}.", 
                        recurrMaster.FirstOccurrence.ItemId.ToString().Substring(144), 
                        recurrMaster.FirstOccurrence.Start.ToString());
    Console.WriteLine("The start time for the last appointment with id \t{0} will be on \t{1}.", 
                        recurrMaster.LastOccurrence.ItemId.ToString().Substring(144), 
                        recurrMaster.LastOccurrence.Start.ToString());
    Console.WriteLine("There are {0} modified occurrences and {1} deleted occurrences.", 
                        recurrMaster.ModifiedOccurrences == null ? "no" : recurrMaster.ModifiedOccurrences.Count.ToString(), 
                        recurrMaster.DeletedOccurrences == null ? "no" : recurrMaster.DeletedOccurrences.Count.ToString());
    // Bind to the first occurrence of a series by using its index.
    Appointment firstOccurrence = Appointment.BindToOccurrence(service, 
                                                                recurrMaster.Id, 
                                                                1, // Index of first item is 1, not 0.
                                                                new PropertySet(AppointmentSchema.AppointmentType,
                                                                                AppointmentSchema.Start));
    Console.WriteLine("Compare the start times for a recurring master's first occurrence " + 
                        "and the occurrence found at index 1 using the BindToOccurrence method:");
    Console.WriteLine("The appointment at index 1 has a start time of\t\t\t\t {0}\n" +
                        "Which matches that of the first occurrence on the recurring master: \t {1}",
                        firstOccurrence.Start.ToString(),
                        recurrMaster.FirstOccurrence.Start.ToString());
}

使用 EWS 访问定期系列中的日历项目

访问定期系列中的日历项目与访问日历项的单个实例非常相似。使用 GetItem 操作请求，指定所需的属性，以及所需的约会实例的 OccurrenceItemId 。 OccurrenceItemId 包含事件的定期主控形状的 ItemID 及其系列中的索引值。

以下 XML 显示了 GetItem 请求，该请求用于返回由其索引指定的序列中的匹配项。请注意，为了提高可读性，定期主控形状的 ItemID 已缩短。

<?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="calendar:CalendarItemType" />
          <t:FieldURI FieldURI="calendar:Start" />
        </t:AdditionalProperties>
      </m:ItemShape>
      <m:ItemIds>
        <t:OccurrenceItemId RecurringMasterId="AAMkA" InstanceIndex="1" />
      </m:ItemIds>
    </m:GetItem>
  </soap:Body>
</soap:Envelope>

服务器使用 GetItemResponse 邮件响应 GetItem 请求，该邮件包含 ResponseCode 值 NoError，该值指示已成功创建电子邮件和新创建的邮件的 ItemId。

通过

在 Exchange 中使用 EWS 访问定期系列

使用 EWS 托管 API 获取定期日历项的集合

使用 EWS 访问定期系列中的日历项目

另请参阅

反馈

其他资源

通过

在 Exchange 中使用 EWS 访问定期系列

使用 EWS 托管 API 获取定期日历项的集合

使用 EWS 托管 API 获取相关的重复日历项

使用 EWS 访问定期系列中的日历项目

另请参阅

反馈

其他资源