CRMEmailTemplate.Assign Method
The Assign method assigns the e-mail template to a security principal (user or team). (See Remarks.) This method also applies to the parent object and associated objects that have the same owner as the parent object. Therefore when you assign the parent object to a new owner, only the associated objects that have the same owner as the parent object are assigned. In addition, when an object is assigned to a new owner, it is shared with the previous owner with full rights. Either the new owner or the previous owner can remove the relationship or lower the level of privileges the previous owner had on the object.
Syntax
[Visual Basic .NET]
Public Sub Assign(
ByVal Caller As CUserAuth,
ByVal TemplateId As String,
ByVal Assignee As CSecurityPrincipal
)
[C#]
public void Assign(
CUserAuth Caller,
string TemplateId,
CSecurityPrincipal Assignee
);
[C++]
public: void Assign(
CUserAuth* Caller,
String* TemplateId,
CSecurityPrincipal* Assignee
);
Parameters
Caller
Specifies the identity of the caller. The caller must have the prvAssignEmailTemplate privilege to perform this action. See CUserAuth.
TemplateId
Specifies the ID of the template.
Assignee
Specifies the new owner of the e-mail template. It can be a user or a team. See CSecurityPrincipal.
Return Value
No return value.
Remarks
Note The Microsoft CRM application does not support business object assignment to teams.
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.Proxy.BizUser bizUser = new Microsoft.CRM.Proxy.BizUser ();
bizUser.Credentials = System.Net.CredentialCache.DefaultCredentials;
bizUser.Url = strDir + "BizUser.srf";
// CRMEmailTemplate proxy object
Microsoft.CRM.Proxy.CRMEmailTemplate emailtemplate = new Microsoft.CRM.Proxy.CRMEmailTemplate();
emailtemplate.Credentials = System.Net.CredentialCache.DefaultCredentials;
emailtemplate.Url = strDir + "CRMEmailTemplate.srf";
string strErrorMsg;
string strEmailTemplateId = "{586D80AA-3E9B-4936-ABCA-2C4EB37FBE82}";
try
{
Microsoft.CRM.Proxy.CUserAuth userAuth = bizUser.WhoAmI();
// Create a new security principal
Microsoft.CRM.Proxy.CSecurityPrincipal securityPrincipal = new Microsoft.CRM.Proxy.CSecurityPrincipal();
securityPrincipal.Id = userAuth.UserId;
securityPrincipal.Type = Microsoft.CRM.Proxy.SecurityPrincipalType.sptUser;
// Now assign the e-mail template to another security principal
emailtemplate.Assign(userAuth, strEmailTemplateId, 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.Proxy
Assembly: microsoft.crm.proxy.dll
See Also