Excluir compromissos e cancelar reuniões usando o EWS no Exchange
Saiba como excluir compromissos e reuniões usando a API Gerenciada do EWS ou o EWS no Exchange.
A diferença essencial entre reuniões e compromissos é que as reuniões têm participantes e os compromissos não. Ambos os compromissos e reuniões podem ser instâncias simples ou parte de uma série recorrente, mas como os compromissos não incluem participantes, salas ou recursos, eles não exigem que uma mensagem seja enviada. Internamente, o Exchange usa o mesmo objeto para reuniões e compromissos. Você usa a classe compromisso da API gerenciada do EWS ou o elemento EWS [CalendarItem](https://msdn.microsoft.com/library/Title Topic ID Project Name Writer Editor Publish Preview.aspx) para trabalhar com reuniões e compromissos.
Tabela 1. Métodos de API Gerenciada do EWS e operações EWS para excluir compromissos e reuniões
Método da API Gerenciada do EWS | Operação do EWS | Função |
---|---|---|
Appointment.Delete |
DeleteItem |
Exclui um compromisso. |
Appointment.Delete |
Operação CreateItem (item do calendário) |
Exclui uma reunião. |
Observe que quando você exclui um compromisso usando o EWS, usa a operação DeleteItem, mas quando exclui uma reunião, usa a operação CreateItem. Isso pode parecer antiintuitivo, mas é porque você precisa criar um objeto de resposta de reunião para enviar mensagens de cancelamento de reunião aos participantes.
Excluir um compromisso usando a API Gerenciada do EWS
O exemplo de código a seguir mostra como usar o método Delete para excluir um compromisso de sua pasta de calendário e o método ExchangeService.FindItems para verificar se o compromisso foi excluído procurando-o na pasta Itens excluídos.
Este exemplo pressupõe que você se autenticou em um servidor Exchange e adquiriu um objetoExchangeService chamado service. A variável appointmentId
local é um identificador associado a um compromisso existente.
// Instantiate an appointment object by binding to it by using the ItemId.
// As a best practice, limit the properties returned to only the ones you need.
Appointment appointment = Appointment.Bind(service, appointmentId, new PropertySet());
// Delete the appointment. Note that the item ID will change when the item is moved to the Deleted Items folder.
appointment.Delete(DeleteMode.MoveToDeletedItems);
// Verify that the appointment has been deleted by looking for a matching subject in the Deleted Items folder's first entry.
ItemView itemView = new ItemView(1);
itemView.Traversal = ItemTraversal.Shallow;
// Just retrieve the properties you need.
itemView.PropertySet = new PropertySet(ItemSchema.Id, ItemSchema.ParentFolderId, ItemSchema.Subject);
// Note that the FindItems method results in a call to EWS.
FindItemsResults<Item> deletedItems = service.FindItems(WellKnownFolderName.DeletedItems, itemView);
Item deletedItem = deletedItems.First();
Folder parentFolder = Folder.Bind(service, deletedItem.ParentFolderId, new PropertySet(FolderSchema.DisplayName));
Console.WriteLine("The appointment " + "\"" + deletedItem.Subject + "\"" + " is now in the " + parentFolder.DisplayName + " folder.");
Este exemplo mostra uma maneira simples de verificar se o compromisso foi excluído, verificando se o assunto do primeiro item na pasta Itens excluídos corresponde ao compromisso excluído. Como você opta por verificar se seu compromisso foi excluído variará com base nas necessidades do seu aplicativo.
Como você pode ver, excluir um compromisso é simples e praticamente o que você pode esperar. Observe quando você cria a etapa de verificação de que o item de compromisso na pasta Itens excluídos tem um ItemId diferente do item de compromisso na pasta de calendário. O item é copiado e excluído, em vez de simplesmente ser movido para a pasta Itens excluídos.
Excluir um compromisso usando o EWS
O XML de solicitação e resposta nos exemplos a seguir correspondem a chamadas feitas pelo código da API Gerenciada do EWS em Excluir um compromisso usando a API Gerenciada do EWS. O XML de solicitação e resposta que verifica se o item de compromisso está na pasta Itens excluídos também é mostrado.
O exemplo a seguir mostra o XML de solicitação para a operação DeleteItem excluir um compromisso.
<?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="Exchange2007_SP1" />
<t:TimeZoneContext>
<t:TimeZoneDefinition Id="Pacific Standard Time" />
</t:TimeZoneContext>
</soap:Header>
<soap:Body>
<m:DeleteItem DeleteType="MoveToDeletedItems" SendMeetingCancellations="SendToAllAndSaveCopy">
<m:ItemIds>
<t:ItemId Id="AAMkA" ChangeKey="DwAAA" />
</m:ItemIds>
</m:DeleteItem>
</soap:Body>
</soap:Envelope>
O exemplo a seguir mostra o XML de resposta retornado pela operação DeleteItem. Os atributos ItemId e ChangeKey são reduzidos para legibilidade.
<?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="800" MinorBuildNumber="5" Version="V2_6"
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:DeleteItemResponse xmlns:m="http://schemas.microsoft.com/exchange/services/2006/messages"
xmlns:t="http://schemas.microsoft.com/exchange/services/2006/types">
<m:ResponseMessages>
<m:DeleteItemResponseMessage ResponseClass="Success">
<m:ResponseCode>NoError</m:ResponseCode>
</m:DeleteItemResponseMessage>
</m:ResponseMessages>
</m:DeleteItemResponse>
</s:Body>
</s:Envelope>
O exemplo a seguir mostra o XML de solicitação para a operação FindItem que recupera o primeiro item na pasta Itens excluídos para comparar o assunto do item com o objeto de compromisso excluído.
<?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="Exchange2007_SP1" />
<t:TimeZoneContext>
<t:TimeZoneDefinition Id="Pacific Standard Time" />
</t:TimeZoneContext>
</soap:Header>
<soap:Body>
<m:FindItem Traversal="Shallow">
<m:ItemShape>
<t:BaseShape>IdOnly</t:BaseShape>
<t:AdditionalProperties>
<t:FieldURI FieldURI="item:ItemId" />
<t:FieldURI FieldURI="item:ParentFolderId" />
<t:FieldURI FieldURI="item:Subject" />
</t:AdditionalProperties>
</m:ItemShape>
<m:IndexedPageItemView MaxEntriesReturned="1" Offset="0" BasePoint="Beginning" />
<m:ParentFolderIds>
<t:DistinguishedFolderId Id="deleteditems" />
</m:ParentFolderIds>
</m:FindItem>
</soap:Body>
</soap:Envelope>
O exemplo a seguir mostra o XML de resposta retornado pela operação FindItem durante a etapa de verificação.
Observação
Os atributos ItemId e ChangeKey são reduzidos para legibilidade.
<?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="800" MinorBuildNumber="5" Version="V2_6"
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:FindItemResponse xmlns:m="http://schemas.microsoft.com/exchange/services/2006/messages"
xmlns:t="http://schemas.microsoft.com/exchange/services/2006/types">
<m:ResponseMessages>
<m:FindItemResponseMessage ResponseClass="Success">
<m:ResponseCode>NoError</m:ResponseCode>
<m:RootFolder IndexedPagingOffset="1" TotalItemsInView="10748" IncludesLastItemInRange="false">
<t:Items>
<t:CalendarItem>
<t:ItemId Id="AAMkA=" ChangeKey="DwAAA" />
<t:ParentFolderId Id="AAMkA" ChangeKey="AQAAA" />
<t:Subject>Tennis lesson</t:Subject>
</t:CalendarItem>
</t:Items>
</m:RootFolder>
</m:FindItemResponseMessage>
</m:ResponseMessages>
</m:FindItemResponse>
</s:Body>
</s:Envelope>
Excluir uma reunião usando a API Gerenciada do EWS
Ao excluir uma reunião, além de remover o item de compromisso da pasta de calendário, você também pode querer enviar cancelamentos de reunião para os participantes. Você pode usar os três métodos a seguir para cancelar uma reunião:
O método escolhido depende do nível de detalhes que você precisa fornecer em sua mensagem de cancelamento. Appointment.CancelMeeting facilita a atualização da mensagem de cancelamento passando uma mensagem atualizada como parâmetro. CancelMeetingMessage permite modificar propriedades em sua mensagem antes de enviar um cancelamento, para que você possa fazer coisas como solicitar um recibo.
Os exemplos de código nesta seção mostram as diferentes maneiras de excluir uma reunião e enviar cancelamentos de reunião. Os exemplos pressupõe que você tenha autenticado em um servidor Exchange e tenha adquirido um objeto ExchangeService chamado service. A variável local meetingId
é um identificador associado a uma reunião existente em que o usuário de destino é o organizador da reunião.
O exemplo de código a seguir mostra como excluir uma reunião usando o método Appointment.Delete.
// Instantiate an appointment object for the meeting by binding to it using the ItemId.
// As a best practice, limit the properties returned to only the Appointment ID.
Appointment meeting = Appointment.Bind(service, meetingId, new PropertySet());
// Delete the meeting by using the Delete method.
meeting.Delete(DeleteMode.MoveToDeletedItems, SendCancellationsMode.SendToAllAndSaveCopy);
// Verify that the meeting has been deleted by looking for a matching subject in the Deleted Items folder's first entry.
ItemView itemView = new ItemView(1);
itemView.Traversal = ItemTraversal.Shallow;
// Just retrieve the properties you need.
itemView.PropertySet = new PropertySet(ItemSchema.Id, ItemSchema.ParentFolderId, ItemSchema.Subject);
// Note that the FindItems method results in a call to EWS.
FindItemsResults<Item> deletedItems = service.FindItems(WellKnownFolderName.DeletedItems, itemView);
Item deletedItem = deletedItems.First();
Folder parentFolder = Folder.Bind(service, deletedItem.ParentFolderId, new PropertySet(FolderSchema.DisplayName));
Console.WriteLine("The meeting " + "\"" + deletedItem.Subject + "\"" + " is now in the " + parentFolder.DisplayName + " folder.");
O exemplo de código a seguir mostra como excluir uma reunião usando o método CancelMeeting.
// Instantiate an appointment object by binding to it using the ItemId.
// As a best practice, limit the properties returned to only the Appointment ID.
Appointment meeting = Appointment.Bind(service, meetingId, new PropertySet());
// Delete the meeting by using the CancelMeeting method.
meeting.CancelMeeting("The outdoor meeting has been cancelled due to hailstorms.");
O exemplo de código a seguir mostra como excluir uma reunião usando o método Appointment.CreateCancelMeetingMessage.
// Instantiate an appointment object by binding to it using the ItemId.
// As a best practice, limit the properties returned to only the Appointment ID.
Appointment meeting = Appointment.Bind(service, meetingId, new PropertySet());
// Delete the meeting by using the CreateCancelMeetingMessage method.
CancelMeetingMessage cancelMessage = meeting.CreateCancelMeetingMessage();
cancelMessage.Body = new MessageBody("The outdoor meeting has been canceled due to hailstorms.");
cancelMessage.IsReadReceiptRequested = true;
cancelMessage.SendAndSaveCopy();
Excluir uma reunião usando o EWS
O XML de solicitação e resposta nos exemplos a seguir correspondem às chamadas feitas pelo código da API gerenciada do EWS no Excluir uma reunião usando a API Gerenciada do EWS usando o método Appointment.Delete.
O exemplo a seguir mostra o XML de solicitação quando você usa a operação CreateItem para enviar mensagens de cancelamento aos participantes e excluir uma reunião.
<?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="Exchange2007_SP1" />
<t:TimeZoneContext>
<t:TimeZoneDefinition Id="Pacific Standard Time" />
</t:TimeZoneContext>
</soap:Header>
<soap:Body>
<m:CreateItem MessageDisposition="SendAndSaveCopy">
<m:Items>
<t:CancelCalendarItem>
<t:ReferenceItemId Id="AAMkA" ChangeKey="DwAAA" />
<t:NewBodyContent BodyType="HTML">The outdoor meeting has been canceled due to hailstorms.</t:NewBodyContent>
</t:CancelCalendarItem>
</m:Items>
</m:CreateItem>
</soap:Body>
</soap:Envelope>
O exemplo a seguir mostra o XML retornado em resposta a uma solicitação de operação CreateItem usada para excluir uma reunião.
Observação
Os atributos ItemId e ChangeKey são reduzidos para legibilidade.
<?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="800" MinorBuildNumber="5" Version="V2_6"
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="AAMkA" ChangeKey="DwAAA" />
</t:CalendarItem>
</m:Items>
</m:CreateItemResponseMessage>
</m:ResponseMessages>
</m:CreateItemResponse>
</s:Body>
</s:Envelope>
O exemplo a seguir mostra o XML de solicitação para a operação FindItem que recupera o primeiro item na pasta Itens excluídos para comparar o assunto do item com o objeto de compromisso excluído.
<?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="Exchange2007_SP1" />
<t:TimeZoneContext>
<t:TimeZoneDefinition Id="Pacific Standard Time" />
</t:TimeZoneContext>
</soap:Header>
<soap:Body>
<m:FindItem Traversal="Shallow">
<m:ItemShape>
<t:BaseShape>IdOnly</t:BaseShape>
<t:AdditionalProperties>
<t:FieldURI FieldURI="item:ItemId" />
<t:FieldURI FieldURI="item:ParentFolderId" />
<t:FieldURI FieldURI="item:Subject" />
</t:AdditionalProperties>
</m:ItemShape>
<m:IndexedPageItemView MaxEntriesReturned="1" Offset="0" BasePoint="Beginning" />
<m:ParentFolderIds>
<t:DistinguishedFolderId Id="deleteditems" />
</m:ParentFolderIds>
</m:FindItem>
</soap:Body>
</soap:Envelope>
O exemplo a seguir mostra o XML retornado pela operação FindItem durante a etapa de verificação.
Observação
Os atributos Id e ChangeKey são reduzidos para legibilidade.
<?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="800" MinorBuildNumber="5" Version="V2_6"
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:FindItemResponse xmlns:m="http://schemas.microsoft.com/exchange/services/2006/messages"
xmlns:t="http://schemas.microsoft.com/exchange/services/2006/types">
<m:ResponseMessages>
<m:FindItemResponseMessage ResponseClass="Success">
<m:ResponseCode>NoError</m:ResponseCode>
<m:RootFolder IndexedPagingOffset="1" TotalItemsInView="10750" IncludesLastItemInRange="false">
<t:Items>
<t:CalendarItem>
<t:ItemId Id="AAMkA" ChangeKey="DwAAA" />
<t:ParentFolderId Id="AAMkA" ChangeKey="AQAAA" />
<t:Subject>Team building exercise</t:Subject>
</t:CalendarItem>
</t:Items>
</m:RootFolder>
</m:FindItemResponseMessage>
</m:ResponseMessages>
</m:FindItemResponse>
</s:Body>
</s:Envelope>
Confira também
- Calendários e EWS no Exchange
- Criar compromissos e reuniões usando o EWS no Exchange 2013
- Obter compromissos e reuniões usando o EWS no Exchange
- Criar compromissos e reuniões usando o EWS no Exchange
- Propor um novo horário de reunião usando o EWS no Exchange
- Propor um novo horário de reunião usando o EWS no Exchange