CopyDynamicListToStaticRequest Class

 

Applies To: Dynamics CRM 2015

Contains the data that is needed to create a static list from the specified dynamic list and add the members that satisfy the dynamic list query criteria to the static 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.CopyDynamicListToStaticRequest

Syntax

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

Constructors

Name Description
System_CAPS_pubmethod CopyDynamicListToStaticRequest()

Initializes a new instance of the CopyDynamicListToStaticRequest class.

Properties

Name Description
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 ListId

Gets or sets the ID of the dynamic list. 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 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.)

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 will return an instance of CopyDynamicListToStaticResponse.

Privileges and Access Rights

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

Notes for Callers

The newly created static list is locked. To unlock the list, set the value of the List.Lockstatus attribute to false.

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 dynamic list to a static list.
CopyDynamicListToStaticRequest copyRequest = 
    new CopyDynamicListToStaticRequest()
    {
        ListId = _dynamicListId
    };
CopyDynamicListToStaticResponse copyResponse =
    (CopyDynamicListToStaticResponse)_serviceProxy.Execute(copyRequest);
_staticListId = copyResponse.StaticListId;

Console.WriteLine("Copied dynamic list to a static list.");


' Copy the dynamic list to a static list.
Dim copyRequest As New CopyDynamicListToStaticRequest() With
    {
        .ListId = _dynamicListId
    }
Dim copyResponse As CopyDynamicListToStaticResponse =
    CType(_serviceProxy.Execute(copyRequest), 
        CopyDynamicListToStaticResponse)
_staticListId = copyResponse.StaticListId

Console.WriteLine("Copied dynamic list to a static list.")

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

CopyDynamicListToStaticResponse
Microsoft.Crm.Sdk.Messages Namespace
List (marketing list) entity
Sample: Distribute campaign activities to dynamic and static lists
CopyDynamicListToStatic 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