java.lang.Object
- java.lang.Enum<NotificationTemplateKey>
- - org.silverpeas.core.notification.user.client.NotificationTemplateKey

All Implemented Interfaces:

Serializable, Comparable<NotificationTemplateKey>
```
public enum NotificationTemplateKey
extends Enum<NotificationTemplateKey>
```
Keys of the predefined fields injected by default in the text templates used in the notifications to users.

Enum Constant Summary

Enum Constants
Enum Constant	Description
`NOTIFICATION_ATTACHMENTS`	Links to the attachments concerned by the notification.
`NOTIFICATION_BASE_SERVER_URL`	The base URL of the server (the port number included if other than 80)
`NOTIFICATION_LINK`	Link to the resource in Silverpeas for which the notification has been sent.
`NOTIFICATION_LINK_LABEL`	Label associated with the notification link above.
`NOTIFICATION_RECEIVER_GROUPS`	The identifiers of the user groups targeted by the notification.
`NOTIFICATION_RECEIVER_USERS`	The identifiers of the users targeted by the notification.
`NOTIFICATION_SENDER_EMAIL`	The email address of the user at the origin of the notification.
`NOTIFICATION_SENDER_NAME`	The name of the user at the origin of the notification.
`NOTIFICATION_SERVER_URL`	The URL of the server including the application context if any (the URL of Silverpeas).

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`toString()`
`static NotificationTemplateKey`	`valueOf(String name)`	Returns the enum constant of this type with the specified name.
`static NotificationTemplateKey[]`	`values()`	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - NOTIFICATION_SENDER_NAME
```
public static final NotificationTemplateKey NOTIFICATION_SENDER_NAME
```
    The name of the user at the origin of the notification.
  - NOTIFICATION_SENDER_EMAIL
```
public static final NotificationTemplateKey NOTIFICATION_SENDER_EMAIL
```
    The email address of the user at the origin of the notification.
  - NOTIFICATION_RECEIVER_USERS
```
public static final NotificationTemplateKey NOTIFICATION_RECEIVER_USERS
```
    The identifiers of the users targeted by the notification.
  - NOTIFICATION_RECEIVER_GROUPS
```
public static final NotificationTemplateKey NOTIFICATION_RECEIVER_GROUPS
```
    The identifiers of the user groups targeted by the notification.
  - NOTIFICATION_BASE_SERVER_URL
```
public static final NotificationTemplateKey NOTIFICATION_BASE_SERVER_URL
```
    The base URL of the server (the port number included if other than 80)
  - NOTIFICATION_SERVER_URL
```
public static final NotificationTemplateKey NOTIFICATION_SERVER_URL
```
    The URL of the server including the application context if any (the URL of Silverpeas).
  - NOTIFICATION_LINK
```
public static final NotificationTemplateKey NOTIFICATION_LINK
```
    Link to the resource in Silverpeas for which the notification has been sent.
  - NOTIFICATION_LINK_LABEL
```
public static final NotificationTemplateKey NOTIFICATION_LINK_LABEL
```
    Label associated with the notification link above.
  - NOTIFICATION_ATTACHMENTS
```
public static final NotificationTemplateKey NOTIFICATION_ATTACHMENTS
```
    Links to the attachments concerned by the notification.
- Method Detail
  - values
```
public static NotificationTemplateKey[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
    for (NotificationTemplateKey c : NotificationTemplateKey.values()) System.out.println(c);
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static NotificationTemplateKey valueOf(String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
    
    Parameters:
    
    name - the name of the enum constant to be returned.
    
    Returns:
    
    the enum constant with the specified name
    
    Throws:
    
    IllegalArgumentException - if this enum type has no constant with the specified name
    
    NullPointerException - if the argument is null
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Enum<NotificationTemplateKey>

Enum NotificationTemplateKey

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

NOTIFICATION_SENDER_NAME

NOTIFICATION_SENDER_EMAIL

NOTIFICATION_RECEIVER_USERS

NOTIFICATION_RECEIVER_GROUPS

NOTIFICATION_BASE_SERVER_URL

NOTIFICATION_SERVER_URL

NOTIFICATION_LINK

NOTIFICATION_LINK_LABEL

NOTIFICATION_ATTACHMENTS

Method Detail

values

valueOf

toString