Package com.inductiveautomation.ignition.client.rpc

Class PlatformRpcInstances

java.lang.Object

com.inductiveautomation.ignition.client.rpc.PlatformRpcInstances

public final class PlatformRpcInstances
extends Object

A collection of RPC interfaces which exist at the platform level and can be used by clients and designers.

Field Summary

Fields

Modifier and Type	Field	Description
static final AuditRpcFunctions	AUDIT_RPC
static final AutocompleteRpc	AUTOCOMPLETE_RPC
static final DatasourceRpc	DATASOURCE_RPC
static final GatewayInfoRpc	GATEWAY_INFO_RPC
static final HolidayRpc	HOLIDAY_RPC
static final LocalizationRpc	LOCALIZATION_RPC
static final NamedQueryRpc	NAMED_QUERY_RPC
static final ProjectsRpc	PROJECTS_RPC
static final QueryRpcInstance	QUERY_RPC
static final ScheduleRpc	SCHEDULE_RPC
static final ScriptMessagingRpc	SCRIPT_MESSAGING_RPC	Warning! Has no timeout.
static final SecurityFunctionsRpc	SECURITY_FUNCTIONS_RPC	Warning! Has no timeout.
static final SwingRpc	SWING_RPC
static final TagProviderRpc	TAG_PROVIDER_RPC
static final UsersRpc	USERS_RPC

Method Summary

Modifier and Type	Method	Description
static Dataset	runTagCalculationQuery(List<? extends Path> paths, List<? extends Aggregate> calculations, Date startDate, Date endDate, List<String> aliases, Flags queryFlags)
static Dataset	runTagDensityQuery(Collection<? extends Path> paths, Date startDate, Date endDate)
static Dataset	runTagHistoryQuery(Collection<? extends Path> paths, Date startDate, Date endDate, int returnSize, Aggregate aggregationMode, ReturnFormat format, List<String> aliases, List<? extends Aggregate> colAggModes, Flags queryFlags)
static Dataset	runTagHistoryQuery(Collection<? extends Path> paths, Date startDate, Date endDate, int returnSize, Aggregate aggregationMode, ReturnFormat format, List<String> aliases, List<? extends Aggregate> colAggModes, Flags queryFlags, int timeoutMillis)
static void	sendEmail(String smtpProfileName, String from, String subject, String body, String contentType, String[] recipients, String[] ccRecipients, String[] bccRecipients, String[] attachNames, String[] attachData, int timeout, int retries, String priority, String[] replyTo)
static void	sendEmail(String smtpHost, String from, String subject, String body, String contentType, String[] recips, String username, String password, String priority, String[] attachNames, String[] attachData, int timeout, String[] replyTo)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

AUTOCOMPLETE_RPC

public static final AutocompleteRpc AUTOCOMPLETE_RPC

GATEWAY_INFO_RPC

public static final GatewayInfoRpc GATEWAY_INFO_RPC

HOLIDAY_RPC

public static final HolidayRpc HOLIDAY_RPC

LOCALIZATION_RPC

public static final LocalizationRpc LOCALIZATION_RPC

NAMED_QUERY_RPC

public static final NamedQueryRpc NAMED_QUERY_RPC

PROJECTS_RPC

public static final ProjectsRpc PROJECTS_RPC

SCHEDULE_RPC

public static final ScheduleRpc SCHEDULE_RPC

SCRIPT_MESSAGING_RPC

public static final ScriptMessagingRpc SCRIPT_MESSAGING_RPC

Warning! Has no timeout. Ensure any calls to script message RPC functions have an externally managed timeout.

SECURITY_FUNCTIONS_RPC

public static final SecurityFunctionsRpc SECURITY_FUNCTIONS_RPC

Warning! Has no timeout. Ensure any calls to these RPC functions have an externally managed timeout.

SWING_RPC

public static final SwingRpc SWING_RPC

AUDIT_RPC

public static final AuditRpcFunctions AUDIT_RPC

USERS_RPC

public static final UsersRpc USERS_RPC

DATASOURCE_RPC

public static final DatasourceRpc DATASOURCE_RPC

QUERY_RPC

public static final QueryRpcInstance QUERY_RPC

TAG_PROVIDER_RPC

public static final TagProviderRpc TAG_PROVIDER_RPC

Method Details

sendEmail

public static void sendEmail(String smtpHost,
 String from,
 String subject,
 String body,
 String contentType,
 String[] recips,
 String username,
 String password,
 String priority,
 String[] attachNames,
 String[] attachData,
 int timeout,
 String[] replyTo)
                      throws Exception

Throws:

Exception

sendEmail

public static void sendEmail(String smtpProfileName,
 String from,
 String subject,
 String body,
 String contentType,
 String[] recipients,
 String[] ccRecipients,
 String[] bccRecipients,
 String[] attachNames,
 String[] attachData,
 int timeout,
 int retries,
 String priority,
 String[] replyTo)
                      throws Exception

Throws:

Exception

runTagHistoryQuery

public static Dataset runTagHistoryQuery(Collection<? extends Path> paths,
 Date startDate,
 Date endDate,
 int returnSize,
 Aggregate aggregationMode,
 ReturnFormat format,
 List<String> aliases,
 List<? extends Aggregate> colAggModes,
 Flags queryFlags)
                                  throws GatewayException

Throws:

GatewayException

runTagHistoryQuery

public static Dataset runTagHistoryQuery(Collection<? extends Path> paths,
 Date startDate,
 Date endDate,
 int returnSize,
 Aggregate aggregationMode,
 ReturnFormat format,
 List<String> aliases,
 List<? extends Aggregate> colAggModes,
 Flags queryFlags,
 int timeoutMillis)
                                  throws GatewayException

Throws:

GatewayException

runTagCalculationQuery

public static Dataset runTagCalculationQuery(List<? extends Path> paths,
 List<? extends Aggregate> calculations,
 Date startDate,
 Date endDate,
 List<String> aliases,
 Flags queryFlags)
                                      throws GatewayException

Throws:

GatewayException

runTagDensityQuery

public static Dataset runTagDensityQuery(Collection<? extends Path> paths,
 Date startDate,
 Date endDate)
                                  throws GatewayException

Throws:

GatewayException