Classe DeleteOpenInstancesRequest

Artigo
12/03/2014

Aplica-se a: CRM 2015 on-prem, CRM Online

Contains the data that is needed to delete instances of a recurring appointment master that have an “Open” state.

Namespace: Microsoft.Crm.Sdk.Messages
Assembly: Microsoft.Crm.Sdk.Proxy (em Microsoft.Crm.Sdk.Proxy.dll)

Sintaxe

'Declaração
<DataContractAttribute(Namespace:="https://schemas.microsoft.com/crm/2011/Contracts")> _
Public NotInheritable Class DeleteOpenInstancesRequest
    Inherits OrganizationRequest

[DataContractAttribute(Namespace="https://schemas.microsoft.com/crm/2011/Contracts")] 
public sealed class DeleteOpenInstancesRequest : OrganizationRequest

Exemplo

The following example shows how to use this message. For this sample to work correctly, you must be connected to the server to get an IOrganizationService interface. For the complete sample, see the link later in this topic.


// Retrieve a recurring appointment series
RecurringAppointmentMaster retrievedRecurringAppointmentSeries = (RecurringAppointmentMaster)_serviceProxy.Retrieve(RecurringAppointmentMaster.EntityLogicalName, _recurringAppointmentMasterId, new ColumnSet(true));

// Use the DeleteOpenInstances message to end the series to the
// last occurring past instance date w.r.t. the series end date
// (i.e., 20 days from today). Effectively, that means that the 
// series will end after the third instance (day 14) as this
// instance is the last occuring past instance w.r.t the specified 
// series end date (20 days from today).
// Also specify that the state of past instances (w.r.t. the series 
// end date) be set to 'completed'.
DeleteOpenInstancesRequest endAppointmentSeries = new DeleteOpenInstancesRequest
{
    Target = retrievedRecurringAppointmentSeries,
    SeriesEndDate = DateTime.Today.AddDays(20),
    StateOfPastInstances = (int)AppointmentState.Completed
};
_serviceProxy.Execute(endAppointmentSeries);

Console.WriteLine("The recurring appointment series has been ended after the third occurrence.");

Comentários

Message Availability

Esta mensagem funciona independentemente de o chamador estar conectado ao servidor ou offline.

Usage

Pass an instance of this class to the Execute method, which returns an instance of DeleteOpenInstancesResponse.

Privileges and Access Rights

To perform this action, the caller must have privileges on the entity specified in the Target property and access rights on the record specified in the Target property. For a list of the privileges required, see DeleteOpenInstances Privileges.

Notes for Callers

Using this message does the following:

Deletes all the “open” and “scheduled” future instances of the specified series from the date specified in the SeriesEndDate property. However, if the state of the future instances is changed to “completed” or “canceled”, they are not deleted.
Sets the status of the past instances to the specified value in the StateOfPastInstances property. However, the past instances are not deleted.
Terminates the series to the last occurring past instance date with respect to the date specified in the SeriesEndDate property, and sets the state of the series to “canceled”.

This allows you to preserve the instances of a recurring appointment series even if you have decided to end it prematurely. This is useful if you have attached notes or attachments to past instances of a recurring appointment series that contain important information about the customer or business.

Hierarquia de Herança

System.Object
Microsoft.Xrm.Sdk.OrganizationRequest
Microsoft.Crm.Sdk.Messages.DeleteOpenInstancesRequest

Segurança do Thread

Todos os membros estáticos (Shared in Visual Basic) desse tipo são protegidos por thread. Não há nenhum garantia de que os membros de instância sejam protegidos por thread.

Plataformas

Plataformas de desenvolvimento

Windows Vista, Windows Server 2003 e

Plataformas de destino

Windows Vista,Windows XP

Change History

Consulte também

Referência

Membros de DeleteOpenInstancesRequest
Namespace Microsoft.Crm.Sdk.Messages

Outros recursos

Delete or End a Recurring Appointment Series or Instance
RecurringAppointmentMaster Entity Messages and Methods
Sample: End a Recurring Appointment Series

Compartilhar via