QualifyMemberListRequest Class

Article
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 qualify the specified list and either override the list members or remove them according to the specified option.

For the Web API use the QualifyMemberList 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.QualifyMemberListRequest

Syntax

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

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

Constructors

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

Properties

	Name	Description
	ExtensionData	Gets or sets the structure that contains extra data. Optional.(Inherited from OrganizationRequest.)
	Item[String]	Gets or sets the indexer for the Parameters collection.(Inherited from OrganizationRequest.)
	ListId	Gets or sets the ID of the list to qualify. Required.
	MembersId	Gets or sets an array of IDs of the members to qualify. Required.
	OverrideorRemove	Gets or sets a value that indicates whether to override or remove the members from the list. Required.
	Parameters	Gets or sets the collection of parameters for the request. Required, but is supplied by derived classes.(Inherited from OrganizationRequest.)
	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.)

Methods

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

Remarks

Message Availability

This message works regardless whether the caller is connected to the server or offline.

Usage

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

Privileges and Access Rights

To perform this action, the caller must have privileges on the List entity and access rights on the records specified in the ListId property and the MembersId property.

For a complete list of required privileges, see QualifyMemberList message privileges.

Notes to Callers

The list members are accounts, contacts, or leads. Qualify means to evaluate which members to keep in the list. You select members to evaluate by using a query. For example, you might search for members that are in a particular zip code. This message is invoked by using Manage Members in the web application.

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.

Partager via