MessageTemplateDefinition (UNITY Server base module 3.3.1 API)

All Known Implementing Classes:

AcceptRegistrationTemplateDef, BaseRegistrationTemplateDef, EmailConfirmationTemplateDef, EnquiryFilledTemplateDef, GenericMessageTemplateDef, InvitationTemplateDef, MobileNumberConfirmationTemplateDef, NewEnquiryTemplateDef, RegistrationWithCommentsTemplateDef, RejectRegistrationTemplateDef, SubmitRegistrationTemplateDef, UpdateRegistrationTemplateDef, UserNotificationTemplateDef
```
public interface MessageTemplateDefinition
```
Message template definition. The implementation defines the contract between the template and the code using the template. In particular all the variables which are supported by the code using the template are defined in the implementation.

Author:

P. Piernik

Field Summary

Fields
Modifier and Type Field Description

static java.lang.String CUSTOM_VAR_PREFIX

static java.lang.String INCLUDE_PREFIX

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method	Description
`default boolean`	`allowCustomVariables()`
`java.util.EnumSet<CommunicationTechnology>`	`getCompatibleTechnologies()`
`java.lang.String`	`getDescriptionKey()`
`java.lang.String`	`getName()`
`java.util.Map<java.lang.String,MessageTemplateVariable>`	`getVariables()`

- Field Detail
  - CUSTOM_VAR_PREFIX
```
static final java.lang.String CUSTOM_VAR_PREFIX
```
    See Also:
    
    Constant Field Values
  - INCLUDE_PREFIX
```
static final java.lang.String INCLUDE_PREFIX
```
    See Also:
    
    Constant Field Values
- Method Detail
  - getDescriptionKey
```
java.lang.String getDescriptionKey()
```
    Returns:
    
    message bundle key with the description of the template definition, with information on the purpose of the messages created with this template.
  - getName
```
java.lang.String getName()
```
    Returns:
    
    unique name of the message template definition
  - getVariables
```
java.util.Map<java.lang.String,MessageTemplateVariable> getVariables()
```
    Returns:
    
    map of variables supported by this template consumer. The map keys are variable names. The values are the keys in the message bundle with descriptions.
  - getCompatibleTechnologies
```
java.util.EnumSet<CommunicationTechnology> getCompatibleTechnologies()
```
    Returns:
    
    set of supported facilities. Message from the template can be sent only by notification channels which are using this facilities.
  - allowCustomVariables
```
default boolean allowCustomVariables()
```