AddRecurrenceRequest Class
Applies To: Microsoft Dynamics CRM 2013, Microsoft Dynamics CRM Online
Contains the data that is needed to add recurrence information to an existing appointment.
Namespace: Microsoft.Crm.Sdk.Messages
Assembly: Microsoft.Crm.Sdk.Proxy (in Microsoft.Crm.Sdk.Proxy.dll)
Syntax
'Declaration
<DataContractAttribute(Namespace:="https://schemas.microsoft.com/crm/2011/Contracts")> _
Public NotInheritable Class AddRecurrenceRequest
Inherits OrganizationRequest
[DataContractAttribute(Namespace="https://schemas.microsoft.com/crm/2011/Contracts")]
public sealed class AddRecurrenceRequest : OrganizationRequest
Example
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.");
}
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 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.
Inheritance Hierarchy
System.Object
Microsoft.Xrm.Sdk.OrganizationRequest
Microsoft.Crm.Sdk.Messages.AddRecurrenceRequest
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.
Platforms
Development Platforms
Windows Server 2008, Windows Server 2012, Windows 7 (All Versions), Windows 8 (All Versions)
Target Platforms
Windows Server 2008, ,Windows Server 2012, ,Windows 7 (All Versions),
Change History
See Also
Reference
AddRecurrenceRequest Members
Microsoft.Crm.Sdk.Messages Namespace
AddRecurrenceResponse
Other Resources
Create a Recurring Appointment Series, Instance or Exception
RecurringAppointmentMaster Entity Messages and Methods
AddRecurrence Privileges
Sample: Convert an Appointment to a Recurring Appointment
Send comments about this topic to Microsoft.
© 2013 Microsoft Corporation. All rights reserved.