Jaa


CreateActivitiesListRequest Class

 

Applies To: Dynamics CRM 2015

Contains the data that is needed to create a quick campaign to distribute an activity to members of a list (marketing list).

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 ref class CreateActivitiesListRequest sealed : OrganizationRequest
[<Sealed>]
[<DataContractAttribute(Namespace = "https://schemas.microsoft.com/crm/2011/Contracts")>]
type CreateActivitiesListRequest = 
    class
        inherit OrganizationRequest
    end
<DataContractAttribute(Namespace := "https://schemas.microsoft.com/crm/2011/Contracts")>
Public NotInheritable Class CreateActivitiesListRequest
    Inherits OrganizationRequest

Constructors

Name Description
System_CAPS_pubmethod CreateActivitiesListRequest()

Initializes a new instance of the CreateActivitiesListRequest class.

Properties

Name Description
System_CAPS_pubproperty Activity

Gets or sets the activity to be distributed. Required.

System_CAPS_pubproperty ExtensionData

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

System_CAPS_pubproperty FriendlyName

Gets or sets a display name for the campaign. Required.

System_CAPS_pubproperty Item[String]

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

System_CAPS_pubproperty ListId

Gets or sets the ID of the list. Required.

System_CAPS_pubproperty Owner

Gets or sets the owner for the activity. Required.

System_CAPS_pubproperty OwnershipOptions

Gets or sets the propagation ownership options. Required.

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

System_CAPS_pubproperty Propagate

Gets or sets a value that indicates whether the activity is both created and executed. Required.

System_CAPS_pubproperty QueueId

Gets or sets the ID of the queue to which the created activities are added. Required.

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 sendEmail

Gets or sets a value that indicates whether to send an email about the new activity. Required.

System_CAPS_pubproperty TemplateId

Gets or sets the ID of the email 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

 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.

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

CreateActivitiesListResponse
Microsoft.Crm.Sdk.Messages Namespace
Campaign entities
Sample: Distribute a quick campaign
CreateActivitiesList 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