InstantiateTemplateRequest Class

  • Article

Applies To: Microsoft Dynamics CRM 2013, Microsoft Dynamics CRM Online

Contains the parameters that are needed to create an email message from a template (email template).

Namespace: Microsoft.Crm.Sdk.Messages
Assembly: Microsoft.Crm.Sdk.Proxy (in Microsoft.Crm.Sdk.Proxy.dll)

Syntax

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

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

Example

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.


// Use the InstantiateTemplate message to create an e-mail message using a template.
InstantiateTemplateRequest instTemplateReq = new InstantiateTemplateRequest
{
    TemplateId = _templateId,
    ObjectId = _accountId,
    ObjectType = Account.EntityLogicalName
};
InstantiateTemplateResponse instTemplateResp = (InstantiateTemplateResponse)_serviceProxy.Execute(instTemplateReq);

// Serialize the email message to XML, and save to a file.
XmlSerializer serializer = new XmlSerializer(typeof(InstantiateTemplateResponse));
string filename = "email-message.xml";
using (StreamWriter writer = new StreamWriter(filename))
{
    serializer.Serialize(writer, instTemplateResp);
}
Console.WriteLine("Created e-mail using the template.");

' Use the InstantiateTemplate message to create an e-mail message using a template.
Dim instTemplateReq As InstantiateTemplateRequest = New InstantiateTemplateRequest With { _
    .TemplateId = _templateId, .ObjectId = _accountId, .ObjectType = Account.EntityLogicalName}
Dim instTemplateResp As InstantiateTemplateResponse = _
    CType(_serviceProxy.Execute(instTemplateReq), InstantiateTemplateResponse)

' Serialize the email message to XML, and save to a file.
Dim serializer As New XmlSerializer(GetType(InstantiateTemplateResponse))
Dim filename As String = "email-message.xml"
Using writer As New StreamWriter(filename)
    serializer.Serialize(writer, instTemplateResp)
End Using
Console.WriteLine("Created e-mail using the template.")

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

Privileges and Access Rights

To perform this action, the caller must have privileges on the Email and Template entities and access rights on the specified record in the TemplateId and ObjectId properties. For a complete list of the required privileges, see InstantiateTemplate Privileges.

Inheritance Hierarchy

System.Object
   Microsoft.Xrm.Sdk.OrganizationRequest
    Microsoft.Crm.Sdk.Messages.InstantiateTemplateRequest

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.

Platforms

Development Platforms

Windows Server 2008, Windows Server 2012, Windows 7 (All Versions), Windows 8 (All Versions)

Target Platforms

Windows Server 2008, ,Windows Server 2012, ,Windows 7 (All Versions),

Change History

See Also

Reference

InstantiateTemplateRequest Members
Microsoft.Crm.Sdk.Messages Namespace

Other Resources

E-mail Activity Entities
Template (E-Mail Template) Entity Messages and Methods
Template Entity Privileges
Sample: Instantiate an Email Using a Template

Send comments about this topic to Microsoft.
© 2013 Microsoft Corporation. All rights reserved.