InstantiateTemplateRequest Class
Updated: November 29, 2016
Applies To: Dynamics 365 (online), Dynamics 365 (on-premises), Dynamics CRM 2016, Dynamics CRM Online
Contains the parameters that are needed to create an email message from a template (email template).
For the Web API use the InstantiateTemplate Action.
Assembly: Microsoft.Crm.Sdk.Proxy (in Microsoft.Crm.Sdk.Proxy.dll)
Microsoft.Xrm.Sdk.OrganizationRequest
Microsoft.Crm.Sdk.Messages.InstantiateTemplateRequest
| Name | Description | |
|---|---|---|
![]() | InstantiateTemplateRequest() | Initializes a new instance of the InstantiateTemplateRequest class. |
| 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. |
| Name | Description | |
|---|---|---|
![]() | Equals(Object) | (Inherited from Object.) |
![]() | GetHashCode() | (Inherited from Object.) |
![]() | GetType() | (Inherited from Object.) |
![]() | ToString() | (Inherited from Object.) |
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.
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.");
Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Microsoft Dynamics 365
© 2016 Microsoft. All rights reserved. Copyright

