com.esri.arcgis.trackinganalyst
Interface IEmailAlertAction

All Superinterfaces:

Serializable

All Known Implementing Classes:

EmailAlertAction, IEmailAlertActionProxy

public interface IEmailAlertAction
extends Serializable

Provides access to properties and methods needed for the Email Alert actions.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Method Summary

String	getDatasetDefinitionID() Dataset Definition ID associated with the service connection to the real-time temporal events.
String[]	getEmailList() List of email addresses for the recipients of the action's Email Alert.
IEmailProperties	getEmailSetupProperties() Property set holding the SMTPServer and domain name to be used to construct the sender email address for the Email Alert messages.
IMessageTemplate	getMessageTemplate() Template for use when constructing the action's Email Alert message body.
void	setDatasetDefinitionID(String pVal) Dataset Definition ID associated with the service connection to the real-time temporal events.
void	setEmailList(String[] pVal) List of email addresses for the recipients of the action's Email Alert.
void	setEmailSetupProperties(IEmailProperties ppVal) Property set holding the SMTPServer and domain name to be used to construct the sender email address for the Email Alert messages.
void	setMessageTemplate(IMessageTemplate pVal) Template for use when constructing the action's Email Alert message body.

Method Detail

getMessageTemplate

IMessageTemplate getMessageTemplate()
                                    throws IOException,
                                           AutomationException

Template for use when constructing the action's Email Alert message body.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Returns:

A reference to a com.esri.arcgis.trackinganalyst.IMessageTemplate

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMessageTemplate

void setMessageTemplate(IMessageTemplate pVal)
                        throws IOException,
                               AutomationException

Template for use when constructing the action's Email Alert message body.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Parameters:

pVal - A reference to a com.esri.arcgis.trackinganalyst.IMessageTemplate (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getEmailList

String[] getEmailList()
                      throws IOException,
                             AutomationException

List of email addresses for the recipients of the action's Email Alert.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setEmailList

void setEmailList(String[] pVal)
                  throws IOException,
                         AutomationException

List of email addresses for the recipients of the action's Email Alert.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getEmailSetupProperties

IEmailProperties getEmailSetupProperties()
                                         throws IOException,
                                                AutomationException

Property set holding the SMTPServer and domain name to be used to construct the sender email address for the Email Alert messages.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Returns:

A reference to a com.esri.arcgis.trackinganalyst.IEmailProperties

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setEmailSetupProperties

void setEmailSetupProperties(IEmailProperties ppVal)
                             throws IOException,
                                    AutomationException

Property set holding the SMTPServer and domain name to be used to construct the sender email address for the Email Alert messages.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Parameters:

ppVal - A reference to a com.esri.arcgis.trackinganalyst.IEmailProperties (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDatasetDefinitionID

String getDatasetDefinitionID()
                              throws IOException,
                                     AutomationException

Dataset Definition ID associated with the service connection to the real-time temporal events.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDatasetDefinitionID

void setDatasetDefinitionID(String pVal)
                            throws IOException,
                                   AutomationException

Dataset Definition ID associated with the service connection to the real-time temporal events.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.