RemoveFromQueueRequest Class

Reference

Definition

Namespace:: Microsoft.Crm.Sdk.Messages

Assembly:: Microsoft.Crm.Sdk.Proxy.dll

Package:: Microsoft.PowerPlatform.Dataverse.Client v1.1.17

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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

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

[<System.Runtime.Serialization.DataContract(Namespace="http://schemas.microsoft.com/crm/2011/Contracts")>]
type RemoveFromQueueRequest = class
    inherit OrganizationRequest

Public NotInheritable Class RemoveFromQueueRequest
Inherits OrganizationRequest

Inheritance: Object

OrganizationRequest
RemoveFromQueueRequest

Attributes: DataContractAttribute

Remarks

For the Web API use the RemoveFromQueue action.

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()

Initializes a new instance of the RemoveFromQueueRequest class.

Properties

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)
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	Gets or sets the ID of the request. Optional. (Inherited from OrganizationRequest)
RequestName	Gets or sets the name of the request. Required, but is supplied by derived classes. (Inherited from OrganizationRequest)

Applies to