Classe PropagateByExpressionRequest

Article
12/01/2014

S'applique à: CRM 2015 on-prem, CRM Online

Contains the data that is needed to create a quick campaign to distribute an activity to accounts, contacts, or leads that are selected by a query.

Espace de noms: Microsoft.Crm.Sdk.Messages
Assembly: Microsoft.Crm.Sdk.Proxy (dans Microsoft.Crm.Sdk.Proxy.dll)

Syntaxe

'Déclaration
<DataContractAttribute(Namespace:="https://schemas.microsoft.com/crm/2011/Contracts")> _
Public NotInheritable Class PropagateByExpressionRequest
    Inherits OrganizationRequest

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

Exemple

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 a Quick Campaign for a set of accounts selected by a query
/// </summary>
/// <param name="activityEntity">
/// An object that indicates activity type for the quick campaign and 
/// contains values for each of activity that will be created
/// </param>
/// <param name="query">
/// A query that provides a list of accounts for which 
/// the 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>        
/// <returns></returns>
public Guid CreateAndRetrieveQuickCampaignForQueryExpression(Entity emailActivityEntity, 
    QueryExpression query, PropagationOwnershipOptions ownershipOption, bool isPropagate)
{
    
    // create the bulkoperation
    PropagateByExpressionRequest request = new PropagateByExpressionRequest() {
        Activity = emailActivityEntity,
        ExecuteImmediately = false, // Default value.
        FriendlyName = "Query Based Quick Campaign",
        OwnershipOptions = ownershipOption,
        QueryExpression = query,
        Owner = new EntityReference("systemuser", _currentUser),
        PostWorkflowEvent = true,
        SendEmail = false,
        TemplateId = Guid.Empty
    };

    PropagateByExpressionResponse response = 
        (PropagateByExpressionResponse)_serviceProxy.Execute(request);

    Guid bulkOpId = 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 bulkOpId;

}

Remarques

Message Availability

Ce message fonctionne, que l'appelant soit connecté au serveur ou en mode hors connexion.

Usage

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

Privileges and Access Rights

To perform this action, the caller must have privileges on the 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 QueueId property and the TemplateId property. For a complete list of the required privileges, see PropagateByExpression Privileges.

Notes for Callers

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

Hiérarchie d'héritage

System.Object
Microsoft.Xrm.Sdk.OrganizationRequest
Microsoft.Crm.Sdk.Messages.PropagateByExpressionRequest

Cohérence de thread

Tous les membres statiques publics (Shared dans Visual Basic) de ce type sont thread-safe. Tous les membres d'instance ne sont pas garantis thread-safe.

Plateformes

Plateformes de développement

Windows Vista, Windows Server 2003 et

Plateformes cibles

Windows Vista,Windows XP

Change History

Voir aussi

Référence

Membres PropagateByExpressionRequest
Espace de noms Microsoft.Crm.Sdk.Messages
PropagateByExpressionResponse

Autres ressources

Campaign Entities
Sample: Distribute a Quick Campaign
PropagateByExpression Privileges
How Role-Based Security Can Be Used to Control Access to Entities in CRM
How Instance-Based Security Can Be Used to Control Access to Entity Instances (Records) in CRM

Partager via