AddPrincipalToQueueRequest Class

Reference

Definition

Namespace:: Microsoft.Crm.Sdk.Messages

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

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

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 to add the specified principal to the list of queue members. If the principal is a team, add each team member to the queue.

public ref class AddPrincipalToQueueRequest sealed : Microsoft::Xrm::Sdk::OrganizationRequest

[System.Runtime.Serialization.DataContract(Namespace="http://schemas.microsoft.com/crm/2011/Contracts")]
public sealed class AddPrincipalToQueueRequest : Microsoft.Xrm.Sdk.OrganizationRequest

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

Public NotInheritable Class AddPrincipalToQueueRequest
Inherits OrganizationRequest

Inheritance: Object

OrganizationRequest
AddPrincipalToQueueRequest

Attributes: DataContractAttribute

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

/// <summary>
/// Demonstrates AddPrincipalToQueue message
/// </summary>
/// <param name="service">The authenticated IOrganizationService instance</param>
/// <param name="principalId">The ID of the principal</param>
/// <param name="isTeam">Whether the principal is a team.</param>
/// <param name="queueId">The ID of the queue</param>
static void AddPrincipalToQueueExample(IOrganizationService service, 
      Guid principalId, 
      bool isTeam, 
      Guid queueId ) {

      Entity principal = new()
      {
         LogicalName = isTeam ? "team" : "systemuser",
         Id = principalId
      };


      AddPrincipalToQueueRequest request = new() { 
         Principal = principal,
         QueueId = queueId
      };

      service.Execute(request);
}

Remarks

For the Web API use the AddPrincipalToQueue action.

Usage

Pass an instance of this class to the Execute(OrganizationRequest) 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 table and access rights on the specified record in the QueueId property.

Constructors

AddPrincipalToQueueRequest()

Initializes a new instance of the AddPrincipalToQueueRequest 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)
Principal	Gets or sets the principal to add to the queue. Required.
QueueId	Gets or sets the ID of the queue. Required
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

Del via