CRMActivity.Handle Method

The Handle method moves an activity to the In Progress (WIPBin) queue of the user.

Syntax

[Visual Basic .NET]
Public Sub Handle(
  ByVal Caller As CUserAuth,
  ByVal EntityId As String,
  ByVal SourceQueueId As String
)

[C#]
public void Handle(
  CUserAuth  Caller,
  string  EntityId,
  string  SourceQueueId
);

[C++]
public: void Handle(
  CUserAuth*  Caller,
  String*  EntityId,
  String*  SourceQueueId
);

Parameters

Caller

Specifies the identity of the caller. To perform this action, the caller must have the prvWriteActivity privilege and access rights on the object to be modified. See CUserAuth.

EntityId

Specifies the ID of the object (activity).

SourceQueueId

Specifies the ID of the source queue.

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";

string strErrorMsg;
string strActivityId = "{33A081D8-ABFF-4103-9E9B-DB0A4B1FD48E}";
string strQueueId = "{JKDED4LL-GH90-43ED-73A9-0B33D205F9N8}";

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

   // Handle the activity
   activity.Handle(userAuth, strActivityId, strQueueId);
   
}
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.