AddPrincipalToQueueRequest Class

Article
11/28/2016

Applies To: Dynamics 365 (online), Dynamics 365 (on-premises), Dynamics CRM 2016, Dynamics CRM Online

Contains the data to add the specified principal to the list of queue members. If the principal is a team, add each team member to the queue.

For the Web API use the AddPrincipalToQueue 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.AddPrincipalToQueueRequest

Syntax

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

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

Constructors

	Name	Description
	AddPrincipalToQueueRequest()	Initializes a new instance of the AddPrincipalToQueueRequest 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.)
	Parameters	Gets or sets the collection of parameters for the request. Required, but is supplied by derived classes.(Inherited from OrganizationRequest.)
	Principal	Gets or sets the principal to add to the queue. Required.
	QueueId	Gets or sets the ID of the queue. 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.)

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 the AddPrincipalToQueueResponse class.

Privileges and Access Rights

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

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