CRMActivity.ModifyAccess Method

  • Article

The ModifyAccess method replaces the access rights on the activity for the specified security principal. This method also applies to all child objects of the activity. For all child objects, if the caller does not have share privileges for those object types or share rights to the objects, the child objects are not shared. As a result, the owner of the object or a user who shares the object with share rights automatically has share rights to all child objects of the activity. In this case, only the lack of privileges to a particular object type prevents the child objects from being shared.

Syntax

[Visual Basic .NET]
Public Sub ModifyAccess(
  ByVal Caller As CUserAuth,
  ByVal ActivityId As String,
  ByVal Rights As UInt32,
  ByVal Grantee As CSecurityPrincipal
)

[C#]
public void ModifyAccess(
  CUserAuth  Caller,
  string  ActivityId,
  uint  Rights,
  CSecurityPrincipal  Grantee
);

[C++]
public: void ModifyAccess(
  CUserAuth*  Caller,
  String*  ActivityId,
  unsigned long  Rights,
  CSecurityPrincipal*  Grantee
);

Parameters

Caller

Specifies the identity of the caller. To perform this action, the caller must be the object owner and have the prvShareActivity. See CUserAuth.

ActivityId

Specifies the ID of the activity.

Rights

Specifies the set of rights to be granted. See ACCESSRIGHTS.

Grantee

Specifies the team or user that will be granted access. See CSecurityPrincipal.

Return Value

No return value.

Remarks

If there is an error, SOAP throws an exception and the error message is reported in System.Web.Services.Protocols.SoapException.Detail.OuterXml.

All IDs passed to the platform are GUIDs wrapped in braces. For example: {6522D89A-A752-4455-A2B0-51494C6957C3}

Example

[C#]
// strServer should be set with the name of the platform Web server
string strServer = "myservername";

// virtualDirectory should be set with the name of the Microsoft CRM
// virtual directory on the platform Web server
string virtualDirectory = "mscrmservices";
string strDir = "https://" + strServer + "/" + virtualDirectory + "/";

// BizUser proxy object
Microsoft.Crm.Platform.Proxy.BizUser bizUser = new Microsoft.Crm.Platform.Proxy.BizUser ();
bizUser.Credentials = System.Net.CredentialCache.DefaultCredentials;
bizUser.Url = strDir + "BizUser.srf";

// CRMActivity proxy object
Microsoft.Crm.Platform.Proxy.CRMActivity activity = new Microsoft.Crm.Platform.Proxy.CRMActivity ();
activity.Credentials = System.Net.CredentialCache.DefaultCredentials;
activity.Url = strDir + "CRMActivity.srf";

// BizMerchant proxy object
Microsoft.Crm.Platform.Proxy.BizMerchant merchant = new Microsoft.Crm.Platform.Proxy.BizMerchant ();
merchant.Credentials = System.Net.CredentialCache.DefaultCredentials;
merchant.Url = strDir + "BizMerchant.srf";

string strErrorMsg;
string strActivityId = "{33A081D8-ABFF-4103-9E9B-DB0A4B1FD48E}";
string strUserId = "{ECF99EF1-3858-4E06-ABD9-EBFE526BF9FF}";

try
{
   Microsoft.Crm.Platform.Proxy.CUserAuth userAuth = bizUser.WhoAmI();

   // Initialize the security principal
   Microsoft.Crm.Platform.Proxy.CSecurityPrincipal securityPrincipal = new Microsoft.Crm.Platform.Proxy.CSecurityPrincipal();
   securityPrincipal.Id = strUserId;
   securityPrincipal.Type = Microsoft.Crm.Platform.Proxy.SecurityPrincipalType.sptUser;

   // Set up the rights
   uint rights = Microsoft.Crm.Platform.Types.AccessRights.CRM_ACCESS_WRITE;

   // Modify access for the security principal
   activity.ModifyAccess(userAuth, strActivityId, rights, securityPrincipal);

}
catch (System.Web.Services.Protocols.SoapException err)
{
   // Process the platform error here
   strErrorMsg = ("ErrorMessage: " + err.Message + " " + err.Detail.OuterXml + " Source: " + err.Source );
}
catch (Exception err)
{
   // Process other errors here
   strErrorMsg = ("ErrorMessage: " + err.Message );
}

Requirements

Namespace: Microsoft.Crm.Platform.Proxy

Assembly: Microsoft.Crm.Platform.Proxy.dll

See Also

© 2005 Microsoft Corporation. All rights reserved.