CreateActivitiesListRequest Class

Grein
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 create a quick campaign to distribute an activity to members of a list (marketing list).

For the Web API use the CreateActivitiesList 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.CreateActivitiesListRequest

Syntax

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

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

Constructors

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

Properties

	Name	Description
	Activity	Gets or sets the activity to be distributed. Required.
	ExtensionData	Gets or sets the structure that contains extra data. Optional.(Inherited from OrganizationRequest.)
	FriendlyName	Gets or sets a display name for the campaign. Required.
	Item[String]	Gets or sets the indexer for the Parameters collection.(Inherited from OrganizationRequest.)
	ListId	Gets or sets the ID of the list. Required.
	Owner	Gets or sets the owner for the activity. Required.
	OwnershipOptions	Gets or sets the propagation ownership options. Required.
	Parameters	Gets or sets the collection of parameters for the request. Required, but is supplied by derived classes.(Inherited from OrganizationRequest.)
	PostWorkflowEvent	Gets or sets a value that indicates whether an asynchronous job is used to distribute an activity, such as an email, fax, or letter, to the members of a list. Required.
	Propagate	Gets or sets a value that indicates whether the activity is both created and executed. Required.
	QueueId	Gets or sets the ID of the queue to which the created activities are added. Required.
	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.)
	sendEmail	Gets or sets a value that indicates whether to send an email about the new activity. Required.
	TemplateId	Gets or sets the ID of the email template. Required.

Methods

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

Remarks

Message Availability

For this message to work, the caller must be connected to the server.

Usage

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

Privileges and Access Rights

To perform this action, the caller must have privileges on the List, Queue, and Template entities and on the specified entity in the Activity property. The caller must also have access rights on the specified records in the following properties: ListId, QueueId, and TemplateId. For a complete list of the required privileges, see CreateActivitiesList message privileges.

Notes for Callers

This operation distributes activities that specify a recipient: a phone call, appointment, letter, fax, or email.

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.

/// <summary>
/// This method creates Quick Campaign for a given Marketing List and retruns the 
/// Guid of the Quich Campaign which is modelled as bulk operation in CRM
/// </summary>
/// <param name="activityEntity">
/// An object that indicates activity type for the quick campaign and 
/// contains values for each activity that will be created
/// </param>
/// <param name="marketingListId">
/// The ID of the marketing list to which quick campaign is distributed
/// </param>
/// <param name="ownershipOption">
/// Specifies who will own the activities created by the Quick Campaign
/// The PropagationOwnershipOptions enum is used to specify value for this parameter
/// </param>
/// <param name="isPropagate">
/// Specifies whether the operation is to be executed. 
/// This input is often 'true' for Quick Campaign
/// </param>              
public Guid CreateAndRetrieveQuickCampaignForMarketingList(
    Entity letterActivityEntity, 
    Guid marketingListId, 
    PropagationOwnershipOptions ownershipOption, 
    bool isPropagate)
{
    //Create the request object from input parameters
    CreateActivitiesListRequest request = new CreateActivitiesListRequest() {
        Activity = letterActivityEntity,
        ListId = marketingListId,
        OwnershipOptions = ownershipOption,
        Propagate = isPropagate,
        TemplateId = Guid.Empty,
        FriendlyName = "Quick Campaign for My List",
        Owner = new EntityReference("systemuser", _currentUser),
        PostWorkflowEvent = true
    };

    //Execute the request
    CreateActivitiesListResponse response = 
        (CreateActivitiesListResponse)_serviceProxy.Execute(request);

    //On executing the request a BulkOperation record would be created in CRM. 
    //If isPropagate is true, a corresponding Async job is also created which runs and creates the required activities 
    //The response has BulkOperationId. This is the Id of the bulkoperation that mimics QuickCampaign in CRM
    Guid BOId = response.BulkOperationId;
    System.Console.WriteLine(
        "Quick Campaign with following name has been created. " 
        + "Please verify in Web app manually: \n" 
        + request.FriendlyName 
        + "\nPress enter to continue....");
    System.Console.ReadLine();

    return BOId;

}

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.

Deila með