RetrieveTeamPrivilegesRequest Class

 

Applies To: Dynamics 365 (online), Dynamics 365 (on-premises), Dynamics CRM 2016, Dynamics CRM Online

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

For the Web API use the RetrieveTeamPrivileges Function.

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

Constructors

Name Description
System_CAPS_pubmethod RetrieveTeamPrivilegesRequest()

Initializes a new instance of the RetrieveTeamPrivilegesRequest 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 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 TeamId

Gets or sets the team for which you want to retrieve privileges.

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

See Also

RetrieveTeamPrivilegesResponse
Microsoft.Crm.Sdk.Messages Namespace
Team entity messages and methods
Sample: Assign a record to a team

Return to top

Microsoft Dynamics 365

© 2016 Microsoft. All rights reserved. Copyright