AddRecurrenceRequest Class

Artikel
11/28/2016

Applies To: Dynamics 365 (online), Dynamics 365 (on-premises), Dynamics CRM 2016, Dynamics CRM Online

Contains the data that is needed to add recurrence information to an existing appointment.

For the Web API use the AddRecurrence Action.

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

Inheritance Hierarchy

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

Syntax

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

<DataContractAttribute(Namespace := "https://schemas.microsoft.com/crm/2011/Contracts")>
Public NotInheritable Class AddRecurrenceRequest
    Inherits OrganizationRequest

Constructors

	Name	Description
	AddRecurrenceRequest()	Initializes a new instance of the AddRecurrenceRequest class.

Properties

	Name	Description
	AppointmentId	Gets or sets the ID of the appointment that needs to be converted into a recurring appointment. Required.
	ExtensionData	Gets or sets the structure that contains extra data. Optional.(Inherited from OrganizationRequest.)
	Item[String]	Gets or sets the indexer for the Parameters collection.(Inherited from OrganizationRequest.)
	Parameters	Gets or sets the collection of parameters for the request. Required, but is supplied by derived classes.(Inherited from OrganizationRequest.)
	RequestId	Gets or sets the ID of an asynchronous operation (system job). Optional. (Inherited from OrganizationRequest.)
	RequestName	Gets or sets the name of the request. Required, but is supplied by derived classes.(Inherited from OrganizationRequest.)
	Target	Gets or sets the target, which is a recurring appointment master record to which the appointment is converted. Required.

Methods

	Name	Description
	Equals(Object)	(Inherited from Object.)
	GetHashCode()	(Inherited from Object.)
	GetType()	(Inherited from Object.)
	ToString()	(Inherited from Object.)

Remarks

Message Availability

This message works regardless whether the caller is connected to the server or offline.

Usage

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

Privileges and Access Rights

To perform this action, the caller must have privileges on the RecurringAppointmentMaster and Appointment entities, and access rights on the specified record in the Target property. For a complete list of the required privileges, see AddRecurrence message privileges.

Notes for Callers

When you convert an existing appointment to a recurring appointment by using this message, the data from the existing appointment is copied to a new recurring appointment master instance, and the existing appointment record is deleted.

Examples

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.



// Specify the recurrence information that needs to be added to the
// existing appointment.
// 1.  Define an anonymous type to define the possible recurrence pattern values.
var RecurrencePatternTypes = new
{
    Daily = 0,
    Weekly = 1,
    Monthly = 2,
    Yearly = 3
};

// 2.  Define an anonymous type to define the possible values for days 
// of the week
var DayOfWeek = new
{
    Sunday = 0x01,
    Monday = 0x02,
    Tuesday = 0x04,
    Wednesday = 0x08,
    Thursday = 0x10,
    Friday = 0x20,
    Saturday = 0x40
};

// 3.  Define an anonymous type to define the possible values  
// for the recurrence rule pattern end type.
var RecurrenceRulePatternEndType = new
{
    NoEndDate = 1,
    Occurrences = 2,
    PatternEndDate = 3
};

// 4.  Finally, use a recurring appointment master object to specify
//     the recurrence information. Other appointment details such as
//     'subject' and 'location' are copied from the existing appointment
//     to the recurring appointment master object.

RecurringAppointmentMaster newRecurringAppointmentInfo = new RecurringAppointmentMaster
    {
        StartTime = DateTime.Now.AddHours(2),
        EndTime = DateTime.Now.AddHours(3),
        RecurrencePatternType = new OptionSetValue(RecurrencePatternTypes.Weekly),
        Interval = 1,
        DaysOfWeekMask = DayOfWeek.Thursday,
        PatternStartDate = DateTime.Today,
        PatternEndType = new OptionSetValue(RecurrenceRulePatternEndType.Occurrences),
        Occurrences = 5
    };


// Use the AddRecurrence message to convert the existing appointment
// object to a recurring appointment master object. The existing
// appointment object is deleted thereafter.

AddRecurrenceRequest recurringInfoRequest = new AddRecurrenceRequest
{
    Target = newRecurringAppointmentInfo,
    AppointmentId = _appointmentId
};

AddRecurrenceResponse recurringInfoResponse = (AddRecurrenceResponse)_serviceProxy.Execute(recurringInfoRequest);
__recurringAppointmentMasterId = recurringInfoResponse.id;

// Verify that the newly created recurring appointment master has same 'subject' 
// as the existing appointment.

RecurringAppointmentMaster retrievedMasterAppointment = (RecurringAppointmentMaster)_serviceProxy.Retrieve(RecurringAppointmentMaster.EntityLogicalName, __recurringAppointmentMasterId, new ColumnSet(true));
if (retrievedMasterAppointment.Subject == "Sample Appointment")
{
    Console.WriteLine("Sample Appointment is converted to a recurring appointment.");
}

Thread Safety

Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Delen via