Package com.microstrategy.web.objects
Interface WebEmailNotification
-
- All Superinterfaces:
WebNotification
public interface WebEmailNotification extends WebNotification
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.lang.String
getEmailBody()
Get the email bodyjava.lang.String
getEmailFooter()
Get the email footerjava.lang.String
getEmailHeader()
E Get the email headerjava.lang.String
getEmailSubject()
Get the email subjectjava.util.Map<java.lang.String,java.lang.String>
getExtraProperties()
Get the extra properties of the notification.int
getNotificationType()
Get the notification typeboolean
isHtml()
Get if the email body is using htmlvoid
setEmailBody(java.lang.String emailBody)
Set the email bodyvoid
setEmailFooter(java.lang.String emailFooter)
Set the email footervoid
setEmailHeader(java.lang.String emailHeader)
Set the email headervoid
setEmailSubject(java.lang.String emailSubject)
Set the email subjectvoid
setExtraProperties(java.util.Map<java.lang.String,java.lang.String> extraProperties)
Set the extra properties of the notification.void
setHtml(boolean isHtml)
Set if the email body is HTMLvoid
setNotificationType(int notificationType)
Set the notification type-
Methods inherited from interface com.microstrategy.web.objects.WebNotification
getUserIds, send, setUserIds
-
-
-
-
Method Detail
-
getEmailSubject
java.lang.String getEmailSubject()
Get the email subject- Returns:
- email subject
-
setEmailSubject
void setEmailSubject(java.lang.String emailSubject)
Set the email subject- Parameters:
emailSubject
-
-
getNotificationType
int getNotificationType()
Get the notification type- Returns:
- notification type
EnumDSSXMLExternalNotificationType
-
setNotificationType
void setNotificationType(int notificationType)
Set the notification type- Parameters:
notificationType
-
-
getEmailBody
java.lang.String getEmailBody()
Get the email body- Returns:
- email body
-
setEmailBody
void setEmailBody(java.lang.String emailBody)
Set the email body- Parameters:
emailBody
- , email body
-
getEmailHeader
java.lang.String getEmailHeader()
E Get the email header- Returns:
- email header
-
setEmailHeader
void setEmailHeader(java.lang.String emailHeader)
Set the email header- Parameters:
emailHeader
-
-
getEmailFooter
java.lang.String getEmailFooter()
Get the email footer- Returns:
- email footer
-
setEmailFooter
void setEmailFooter(java.lang.String emailFooter)
Set the email footer- Parameters:
emailFooter
- , email footer
-
isHtml
boolean isHtml()
Get if the email body is using html- Returns:
- if the email body is using html
-
setHtml
void setHtml(boolean isHtml)
Set if the email body is HTML- Parameters:
isHtml
- if the email body is HTML
-
getExtraProperties
java.util.Map<java.lang.String,java.lang.String> getExtraProperties()
Get the extra properties of the notification. Extra properties allow to put extra properties into the notification that are not by default supported. Key => represent the type of the property. Value => represent the value of the property.- Returns:
- email subject
-
setExtraProperties
void setExtraProperties(java.util.Map<java.lang.String,java.lang.String> extraProperties)
Set the extra properties of the notification. Extra properties allow to put extra properties into the notification that are not by default supported. Key => represent the type of the property. Value => represent the value of the property.- Parameters:
extraProperties
- map of the extra properties.
-
-