AddPrincipalToQueueRequest Class

 

Applies To: Dynamics CRM 2015

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.

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

Constructors

Name Description
System_CAPS_pubmethod AddPrincipalToQueueRequest()

Initializes a new instance of the AddPrincipalToQueueRequest 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 Principal

Gets or sets the principal to add to the queue. Required.

System_CAPS_pubproperty QueueId

Gets or sets the ID of the queue. Required

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

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

See Also

AddPrincipalToQueueResponse
Microsoft.Crm.Sdk.Messages Namespace
Sample: Add a security principal (user or team) to a queue (early bound)
Queue entity messages and methods

Return to top

© 2016 Microsoft. All rights reserved. Copyright