RetrieveTeamPrivilegesRequest Class

Article
10/20/2016

Applies To: Dynamics CRM 2015

Contains the data that is needed to retrieve the privileges for a team.

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

Syntax

[DataContractAttribute(Namespace = "https://schemas.microsoft.com/crm/2011/Contracts")]
public sealed class RetrieveTeamPrivilegesRequest : OrganizationRequest

[DataContractAttribute(Namespace = "https://schemas.microsoft.com/crm/2011/Contracts")]
public ref class RetrieveTeamPrivilegesRequest sealed : OrganizationRequest

[<Sealed>]
[<DataContractAttribute(Namespace = "https://schemas.microsoft.com/crm/2011/Contracts")>]
type RetrieveTeamPrivilegesRequest = 
    class
        inherit OrganizationRequest
    end

<DataContractAttribute(Namespace := "https://schemas.microsoft.com/crm/2011/Contracts")>
Public NotInheritable Class RetrieveTeamPrivilegesRequest
    Inherits OrganizationRequest

Constructors

	Name	Description
	RetrieveTeamPrivilegesRequest()	Initializes a new instance of the RetrieveTeamPrivilegesRequest class.

Properties

	Name	Description
	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.)
	RequestId	Gets or sets the ID of an asynchronous operation (system job). Optional. (Inherited from OrganizationRequest.)
	RequestName	Gets or sets the name of the request. Required, but is supplied by derived classes.(Inherited from OrganizationRequest.)
	TeamId	Gets or sets the team for which you want to retrieve privileges.

Methods

	Name	Description
	Equals(Object)	(Inherited from Object.)
	GetHashCode()	(Inherited from Object.)
	GetType()	(Inherited from Object.)
	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 RetrieveTeamPrivilegesResponse class.

Privileges and Access Rights

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

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. For the complete sample, see the link later in this topic.


' It takes some time for the privileges to propagate to the team. Delay the
' application until the privilege has been assigned.
Dim teamLacksPrivilege As Boolean = True
Do While teamLacksPrivilege
    Dim retrieveTeamPrivilegesRequest As RetrieveTeamPrivilegesRequest = _
        New RetrieveTeamPrivilegesRequest With {.TeamId = _teamId}

    Dim retrieveTeamPrivilegesResponse As RetrieveTeamPrivilegesResponse = _
        CType(_service.Execute(retrieveTeamPrivilegesRequest), RetrieveTeamPrivilegesResponse)

    For Each rp As RolePrivilege In retrieveTeamPrivilegesResponse.RolePrivileges
        If rp.PrivilegeId = readAccountPrivilege.Id Then
            teamLacksPrivilege = False
            Exit For
        Else
            System.Threading.Thread.CurrentThread.Join(500)
        End If
    Next rp
Loop

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.

Share via