AddToQueueRequest Class

Article
04/10/2018

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

Contains the data that is needed to move an entity record from a source queue to a destination queue.

For the Web API use the AddToQueue 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.AddToQueueRequest

Syntax

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

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

Constructors

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

Properties

	Name	Description
	DestinationQueueId	Gets or sets the ID of the destination queue. Required.
	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.)
	QueueItemProperties	Gets or sets the properties that are needed to create a queue item in the destination queue. Optional.
	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.)
	SourceQueueId	Gets or sets the ID of the source queue. Optional.
	Target	Gets or sets the target record to add to the destination queue. Required.

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 theExecute method, which returns an instance of the AddToQueueResponse class.

Privileges and Access Rights

To perform this action, the caller must have privileges on the Queue and QueueItem entities and on the entity that is referred to in the Target property. You must also have access rights on the source and destination queue records and on the specified record in the Target property. For a complete list of required privileges, see AddToQueue message privileges.

Notes for Callers

Specifying the SourceQueueId property is optional. If the record that is specified by the Target is not in a queue, it is added to the destination queue. If the record is already in a queue, it is moved from the queue to the destination queue. The records cannot be added to multiple queues, except for email activities created from incoming email messages (Track in CRM). However, a “Received” email record cannot be added multiple times to the same queue.

Specifying the QueueItemProperties property is optional. The minimally required data for creating a queue item is provided in the DestinationQueueId and Target properties. However, if you want to include additional data, such as who works on the case (QueueItem.WorkerId), or to add custom fields, you have to use the QueueItemProperties property.

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.


// Move a record from a source queue to a destination queue
// by using the AddToQueue request message.
AddToQueueRequest routeRequest = new AddToQueueRequest
{
    SourceQueueId = sourceQueueId,
    Target = new EntityReference(Letter.EntityLogicalName, _letterId),
    DestinationQueueId = destinationQueueId
};

// Execute the Request
_serviceProxy.Execute(routeRequest);

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.