Class ClientNetUtilities
- java.lang.Object
-
- com.inductiveautomation.ignition.common.script.builtin.AbstractNetUtilities
-
- com.inductiveautomation.ignition.client.script.ClientNetUtilities
-
public class ClientNetUtilities extends AbstractNetUtilities
-
-
Field Summary
-
Fields inherited from class com.inductiveautomation.ignition.common.script.builtin.AbstractNetUtilities
commonContext
-
-
Constructor Summary
Constructors Constructor Description ClientNetUtilities(CommonContext context)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected void
_sendEmail(java.lang.String smtpSettingsName, java.lang.String from, java.lang.String subject, java.lang.String body, boolean html, java.lang.String[] recipients, java.lang.String[] ccRecipients, java.lang.String[] bccRecipients, java.lang.String[] attachNamesArg, byte[][] attachBytesArg, int timeout, int retries, java.lang.String priority, java.lang.String[] replyTo)
Sends an email with or without authorization and attachments, depending an what arguments are null.protected void
_sendEmail(java.lang.String smtp, java.lang.String from, java.lang.String subject, java.lang.String body, boolean html, java.lang.String[] recips, java.lang.String username, java.lang.String password, java.lang.String priority, java.lang.String[] attachNamesArg, byte[][] attachBytesArg, int timeout, java.lang.String[] replyTo)
Sends an email with or without authorization and attachments, depending an what arguments are null.protected java.util.List<java.lang.String>
getRemoteServers(java.lang.Boolean getRunningOnly)
Returns a list of Gateway Network servers that are visible on the local Gateway.-
Methods inherited from class com.inductiveautomation.ignition.common.script.builtin.AbstractNetUtilities
generateEmailContentType, getHostName, getIpAddress, getRemoteServers, httpClient, httpDelete, httpGet, httpPost, httpPost, httpPut, httpPut, sendAuthEmail, sendAuthEmail, sendAuthEmail, sendEmail
-
-
-
-
Constructor Detail
-
ClientNetUtilities
public ClientNetUtilities(CommonContext context)
-
-
Method Detail
-
_sendEmail
protected void _sendEmail(java.lang.String smtp, java.lang.String from, java.lang.String subject, java.lang.String body, boolean html, java.lang.String[] recips, java.lang.String username, java.lang.String password, java.lang.String priority, java.lang.String[] attachNamesArg, byte[][] attachBytesArg, int timeout, java.lang.String[] replyTo)
Description copied from class:AbstractNetUtilities
Sends an email with or without authorization and attachments, depending an what arguments are null. This method is retained for backwards compatibility- Specified by:
_sendEmail
in classAbstractNetUtilities
- Parameters:
smtp
- Address of the mail server, for example, mail.mycompany.comfrom
- An email address to use as the email's from address. Also the return address.subject
- The subject of the email.body
- The body of the email.html
- A boolean (0/1) indicating whether or not the body is HTML formatted.recips
- A python sequence of recipient email addresses.replyTo
- A python sequence of reply-to email addresses.
-
_sendEmail
protected void _sendEmail(java.lang.String smtpSettingsName, java.lang.String from, java.lang.String subject, java.lang.String body, boolean html, java.lang.String[] recipients, java.lang.String[] ccRecipients, java.lang.String[] bccRecipients, java.lang.String[] attachNamesArg, byte[][] attachBytesArg, int timeout, int retries, java.lang.String priority, java.lang.String[] replyTo)
Description copied from class:AbstractNetUtilities
Sends an email with or without authorization and attachments, depending an what arguments are null.- Specified by:
_sendEmail
in classAbstractNetUtilities
- Parameters:
smtpSettingsName
- Name of an existing smtpSettings record to usefrom
- An email address to use as the email's from address. Also the return address.subject
- The subject of the email.body
- The body of the email.html
- A boolean (0/1) indicating whether or not the body is HTML formatted.recipients
- A python sequence of recipient email addresses.attachNamesArg
- List of attachment namesattachBytesArg
- List of attachment data, must be the same length as the namesreplyTo
- A python sequence of reply-to email addresses.
-
getRemoteServers
protected java.util.List<java.lang.String> getRemoteServers(java.lang.Boolean getRunningOnly) throws GatewayException
Description copied from class:AbstractNetUtilities
Returns a list of Gateway Network servers that are visible on the local Gateway.- Specified by:
getRemoteServers
in classAbstractNetUtilities
- Parameters:
getRunningOnly
- set to true to indicate that only currently reachable servers should be returned- Returns:
- a List of Strings representing ServerIds
- Throws:
GatewayException
-
-