OrganizationServiceContextExtensions.DistributeCampaignActivity Method (OrganizationServiceContext, Guid, Boolean, Entity, Guid, Object, EntityReference, Boolean, Guid)

Applies To: Dynamics CRM 2013

Creates a bulk operation to distribute the activity, creating the appropriate activity for each member in the list for the specified campaign activity. (Developer Extensions)

Namespace:   Microsoft.Xrm.Client.Messages
Assembly:  Microsoft.Xrm.Client (in Microsoft.Xrm.Client.dll)

Syntax

public static Guid DistributeCampaignActivity(
    this OrganizationServiceContext context,
    Guid campaignActivityId,
    bool propagate,
    Entity activity,
    Guid templateId,
    object ownershipOptions,
    EntityReference owner,
    bool sendEmail,
    Guid queueId
)

public:
[ExtensionAttribute]
static Guid DistributeCampaignActivity(
    OrganizationServiceContext^ context,
    Guid campaignActivityId,
    bool propagate,
    Entity^ activity,
    Guid templateId,
    Object^ ownershipOptions,
    EntityReference^ owner,
    bool sendEmail,
    Guid queueId
)

static member DistributeCampaignActivity : 
        context:OrganizationServiceContext *
        campaignActivityId:Guid *
        propagate:bool *
        activity:Entity *
        templateId:Guid *
        ownershipOptions:Object *
        owner:EntityReference *
        sendEmail:bool *
        queueId:Guid -> Guid

<ExtensionAttribute>
Public Shared Function DistributeCampaignActivity (
    context As OrganizationServiceContext,
    campaignActivityId As Guid,
    propagate As Boolean,
    activity As Entity,
    templateId As Guid,
    ownershipOptions As Object,
    owner As EntityReference,
    sendEmail As Boolean,
    queueId As Guid
) As Guid

Parameters

• context
  Type: Microsoft.Xrm.Sdk.Client.OrganizationServiceContext

  The organization service context.

• campaignActivityId
  Type: System.Guid

  The ID of the campaign activity for which the activity is distributed. Required.

• propagate
  Type: System.Boolean

  A value that indicates whether the activity is both created and executed. Required.

• activity
  Type: Microsoft.Xrm.Sdk.Entity

  The activity to be distributed. Required.

• templateId
  Type: System.Guid

  the ID of the email template. Required.

• ownershipOptions
  Type: System.Object

  The ownership options for the activity. Required.

• owner
  Type: Microsoft.Xrm.Sdk.EntityReference

  The owner for the newly created activity. Required.

• sendEmail
  Type: System.Boolean

  A value that indicates whether to send an email about the new activity. Required.

• queueId
  Type: System.Guid

  The ID of the queue to which the created activity is added. Optional.

Return Value

Type: System.Guid

Returns a Guid, the ID of the bulk operation that is used to distribute the campaign activity.

Remarks

This is a method wrapper for the DistributeCampaignActivityRequest and DistributeCampaignActivityResponse classes. See the documentation in the Request class for more information about this message.

See Also

OrganizationServiceContextExtensions Class
Microsoft.Xrm.Client.Messages Namespace
Developer extensions for Microsoft Dynamics CRM 2013

Return to top