PickFromQueueRequest Class

 

Applies To: Dynamics CRM 2015

Contains the data that is needed to assign a queue item to a user and optionally remove the queue item from the queue.

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.PickFromQueueRequest

Syntax

[DataContractAttribute(Namespace = "http://schemas.microsoft.com/crm/2011/Contracts")]
public sealed class PickFromQueueRequest : OrganizationRequest
[DataContractAttribute(Namespace = "http://schemas.microsoft.com/crm/2011/Contracts")]
public ref class PickFromQueueRequest sealed : OrganizationRequest
[<Sealed>]
[<DataContractAttribute(Namespace = "http://schemas.microsoft.com/crm/2011/Contracts")>]
type PickFromQueueRequest = 
    class
        inherit OrganizationRequest
    end
<DataContractAttribute(Namespace := "http://schemas.microsoft.com/crm/2011/Contracts")>
Public NotInheritable Class PickFromQueueRequest
    Inherits OrganizationRequest

Constructors

Name Description
System_CAPS_pubmethod PickFromQueueRequest()

Initializes a new instance of the PickFromQueueRequest class.

Properties

Name Description
System_CAPS_pubproperty ExtensionData

Gets or sets the structure that contains extra data. Optional.(Inherited from OrganizationRequest.)

System_CAPS_pubproperty Item[String]

Gets or sets the indexer for the Parameters collection.(Inherited from OrganizationRequest.)

System_CAPS_pubproperty Parameters

Gets or sets the collection of parameters for the request. Required, but is supplied by derived classes.(Inherited from OrganizationRequest.)

System_CAPS_pubproperty QueueItemId

Gets or sets the

System_CAPS_pubproperty RemoveQueueItem

Gets or sets whether the queue item should be removed from the queue.

System_CAPS_pubproperty RequestId

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

System_CAPS_pubproperty RequestName

Gets or sets the name of the request. Required, but is supplied by derived classes.(Inherited from OrganizationRequest.)

System_CAPS_pubproperty WorkerId

Gets or sets the user to assign the queue item to. Required.

Methods

Name Description
System_CAPS_pubmethod Equals(Object)

(Inherited from Object.)

System_CAPS_pubmethod GetHashCode()

(Inherited from Object.)

System_CAPS_pubmethod GetType()

(Inherited from Object.)

System_CAPS_pubmethod 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 PickFromQueueResponse class.

Privileges and Access Rights

To perform this action, the caller must have privileges on the QueueItem entity and access rights on the specified record in the QueueItemId property. For a complete list of the required privileges, see PickFromQueue 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.

See Also

PickFromQueueResponse
Microsoft.Crm.Sdk.Messages Namespace
Queue entities
QueueItem entity messages and methods
Sample: Specify a queue item to work on (early bound)

Return to top

© 2016 Microsoft. All rights reserved. Copyright