InstantiateTemplateRequest Class

Article
10/20/2016

Applies To: Dynamics CRM 2015

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)

Inheritance Hierarchy

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

Syntax

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

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

[<Sealed>]
[<DataContractAttribute(Namespace = "https://schemas.microsoft.com/crm/2011/Contracts")>]
type InstantiateTemplateRequest = 
    class
        inherit OrganizationRequest
    end

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

Constructors

	Name	Description
	InstantiateTemplateRequest()	Initializes a new instance of the InstantiateTemplateRequest class.

Properties

	Name	Description
	ExtensionData	Gets or sets the structure that contains extra data. Optional.(Inherited from OrganizationRequest.)
	Item[String]	Gets or sets the indexer for the Parameters collection.(Inherited from OrganizationRequest.)
	ObjectId	Gets or sets the ID of the record that the email is regarding. Required.
	ObjectType	Gets or sets the type of entity that is represented by the ObjectId property. Required.
	Parameters	Gets or sets the collection of parameters for the request. Required, but is supplied by derived classes.(Inherited from OrganizationRequest.)
	RequestId	Gets or sets the ID of an asynchronous operation (system job). Optional. (Inherited from OrganizationRequest.)
	RequestName	Gets or sets the name of the request. Required, but is supplied by derived classes.(Inherited from OrganizationRequest.)
	TemplateId	Gets or sets the ID of the template. Required.

Methods

	Name	Description
	Equals(Object)	(Inherited from Object.)
	GetHashCode()	(Inherited from Object.)
	GetType()	(Inherited from Object.)
	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 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 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.



// 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.")

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.