CopyCampaignRequest Class

 

Applies To: Dynamics CRM 2015

Contains the data that is needed to copy a campaign.

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.CopyCampaignRequest

Syntax

[DataContractAttribute(Namespace = "http://schemas.microsoft.com/crm/2011/Contracts")]
public sealed class CopyCampaignRequest : OrganizationRequest
[DataContractAttribute(Namespace = "http://schemas.microsoft.com/crm/2011/Contracts")]
public ref class CopyCampaignRequest sealed : OrganizationRequest
[<Sealed>]
[<DataContractAttribute(Namespace = "http://schemas.microsoft.com/crm/2011/Contracts")>]
type CopyCampaignRequest = 
    class
        inherit OrganizationRequest
    end
<DataContractAttribute(Namespace := "http://schemas.microsoft.com/crm/2011/Contracts")>
Public NotInheritable Class CopyCampaignRequest
    Inherits OrganizationRequest

Constructors

Name Description
System_CAPS_pubmethod CopyCampaignRequest()

Initializes a new instance of the CopyCampaignRequest class.

Properties

Name Description
System_CAPS_pubproperty BaseCampaign

Gets or sets the ID of the base campaign to copy from. Required.

System_CAPS_pubproperty ExtensionData

Gets or sets the structure that contains extra data. Optional.(Inherited from OrganizationRequest.)

System_CAPS_pubproperty Item[String]

Gets or sets the indexer for the Parameters collection.(Inherited from OrganizationRequest.)

System_CAPS_pubproperty Parameters

Gets or sets the collection of parameters for the request. Required, but is supplied by derived classes.(Inherited from OrganizationRequest.)

System_CAPS_pubproperty RequestId

Gets or sets the ID of an asynchronous operation (system job). Optional. (Inherited from OrganizationRequest.)

System_CAPS_pubproperty RequestName

Gets or sets the name of the request. Required, but is supplied by derived classes.(Inherited from OrganizationRequest.)

System_CAPS_pubproperty SaveAsTemplate

Gets or sets a value that indicates whether to save the campaign as a template. Required.

Methods

Name Description
System_CAPS_pubmethod Equals(Object)

(Inherited from Object.)

System_CAPS_pubmethod GetHashCode()

(Inherited from Object.)

System_CAPS_pubmethod GetType()

(Inherited from Object.)

System_CAPS_pubmethod 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 CopyCampaignResponse.

Privileges and Access Rights

To perform this action, the caller must have privileges on the Campaign entity and access rights on the record specified in the BaseCampaign property. For a complete list of required privileges, see CopyCampaign message privileges.

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.


// Copy the campaign.
var campaignCopyRequest = new CopyCampaignRequest
{
    BaseCampaign = _originalCampaignId
};

var copyCampaignResponse =
    (CopyCampaignResponse)_serviceProxy.Execute(campaignCopyRequest);
_campaignId = copyCampaignResponse.CampaignCopyId;

Console.WriteLine("  Copied the campaign to new campaign with GUID \r\n\t{{{0}}}",
    _campaignId);

' Copy the campaign.
         Dim campaignCopyRequest = New CopyCampaignRequest With
                                   {
                                       .BaseCampaign = _originalCampaignId
                                   }

         Dim copyCampaignResponse =
             CType(_serviceProxy.Execute(campaignCopyRequest), 
                 CopyCampaignResponse)
_campaignId = copyCampaignResponse.CampaignCopyId

         Console.WriteLine("  Copied the campaign to new campaign with GUID " _
                           &amp; vbCrLf &amp; vbTab &amp; "{{{0}}}", _campaignId)

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.

See Also

CopyCampaignResponse
Microsoft.Crm.Sdk.Messages Namespace
Campaign entities
Sample: Distribute campaign activities to qualified marketing list
CopyCampaign message privileges
How role-based security can be used to control access to entities in Microsoft Dynamics CRM
How record-based security can be used to control access to records in Microsoft Dynamics CRM

Return to top

© 2016 Microsoft. All rights reserved. Copyright