RemoveFromQueueRequest RemoveFromQueueRequest RemoveFromQueueRequest RemoveFromQueueRequest Class

Definition

Contains the data that is needed to remove a queue item from a queue.

For the Web API use the RemoveFromQueue Action.

public ref class RemoveFromQueueRequest sealed : Microsoft::Xrm::Sdk::OrganizationRequest
[System.Runtime.Serialization.DataContract(Namespace="http://schemas.microsoft.com/crm/2011/Contracts")]
public sealed class RemoveFromQueueRequest : Microsoft.Xrm.Sdk.OrganizationRequest
type RemoveFromQueueRequest = class
    inherit OrganizationRequest
Public NotInheritable Class RemoveFromQueueRequest
Inherits OrganizationRequest
Inheritance
RemoveFromQueueRequestRemoveFromQueueRequestRemoveFromQueueRequestRemoveFromQueueRequest
Attributes

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(OrganizationRequest) method, which returns an instance of RemoveFromQueueResponse.

Privileges and Access Rights

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

Notes for Callers

This method is equivalent to deleting the queue item.

Constructors

RemoveFromQueueRequest() RemoveFromQueueRequest() RemoveFromQueueRequest() RemoveFromQueueRequest()

Initializes a new instance of the RemoveFromQueueRequest class.

Properties

ExtensionData ExtensionData ExtensionData ExtensionData

Gets or sets the structure that contains extra data. Optional.

(Inherited from OrganizationRequest)
Item[String] Item[String] Item[String] Item[String]

Gets or sets the indexer for the Parameters collection.

(Inherited from OrganizationRequest)
Parameters Parameters Parameters Parameters

Gets or sets the collection of parameters for the request. Required, but is supplied by derived classes.

(Inherited from OrganizationRequest)
QueueItemId QueueItemId QueueItemId QueueItemId

Gets or sets the ID of the queue item to remove from the queue. Required.

The QueueItemId property corresponds to the QueueItem.QueueItemId attribute, which is the primary key for the QueueItem entity.

RequestId RequestId RequestId RequestId

Gets or sets the ID of an asynchronous operation (system job). Optional.

(Inherited from OrganizationRequest)
RequestName RequestName RequestName RequestName

Gets or sets the name of the request. Required, but is supplied by derived classes.

(Inherited from OrganizationRequest)

Applies to

See also