Class PlatformRpcInstances
java.lang.Object
com.inductiveautomation.ignition.client.rpc.PlatformRpcInstances
A collection of RPC interfaces which exist at the platform level and can be used by clients and
designers.
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final AuditRpcFunctionsstatic final AutocompleteRpcstatic final DatasourceRpcstatic final GatewayInfoRpcstatic final HolidayRpcstatic final LocalizationRpcstatic final NamedQueryRpcstatic final ProjectsRpcstatic final QueryRpcInstancestatic final ScheduleRpcstatic final ScriptMessagingRpcWarning! Has no timeout.static final SecretsRpcstatic final SecurityFunctionsRpcWarning! Has no timeout.static final SwingRpcstatic final TagProviderRpcstatic final UsersRpc -
Method Summary
Modifier and TypeMethodDescriptionstatic voidaudit(String auditProfile, @Nullable Date eventTimestamp, @Nullable String actor, @Nullable String actorHost, @Nullable String action, @Nullable String actionTarget, @Nullable String actionValue, @Nullable Integer statusCode, @Nullable Integer originatingContext, @Nullable List<String> originatingSystem, @Nullable String previousValue) Client/designer-scope entry point for the audit-write RPC.static DatasetrunTagCalculationQuery(List<? extends Path> paths, List<? extends Aggregate> calculations, Date startDate, Date endDate, List<String> aliases, Flags queryFlags) static DatasetrunTagDensityQuery(Collection<? extends Path> paths, Date startDate, Date endDate) static DatasetrunTagHistoryQuery(Collection<? extends Path> paths, Date startDate, Date endDate, int returnSize, Aggregate aggregationMode, ReturnFormat format, List<String> aliases, List<? extends Aggregate> colAggModes, Flags queryFlags) static DatasetrunTagHistoryQuery(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 voidsendEmail(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 voidsendEmail(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) static TagProviderRpctagProviderRpc(Supplier<GatewayConnection> connection) ATagProviderRpcproxy whose calls go to the gateway at the far end of the connectionconnectionyields at the time of each call;TAG_PROVIDER_RPCis one over the connectionGatewayConnectionManagerholds.
-
Field Details
-
AUTOCOMPLETE_RPC
-
GATEWAY_INFO_RPC
-
HOLIDAY_RPC
-
LOCALIZATION_RPC
-
NAMED_QUERY_RPC
-
PROJECTS_RPC
-
SCHEDULE_RPC
-
SCRIPT_MESSAGING_RPC
Warning! Has no timeout. Ensure any calls to script message RPC functions have an externally managed timeout. -
SECURITY_FUNCTIONS_RPC
Warning! Has no timeout. Ensure any calls to these RPC functions have an externally managed timeout. Thesystem.securityscripting functions bound their calls with the scriptingtimeoutkeyword argument. -
SWING_RPC
-
AUDIT_RPC
-
USERS_RPC
-
DATASOURCE_RPC
-
QUERY_RPC
-
TAG_PROVIDER_RPC
-
SECRETS_RPC
-
-
Method Details
-
tagProviderRpc
ATagProviderRpcproxy whose calls go to the gateway at the far end of the connectionconnectionyields at the time of each call;TAG_PROVIDER_RPCis one over the connectionGatewayConnectionManagerholds. Calls time out after the Designer session timeout.- Parameters:
connection- yields the connection to call the gateway over, on each call.
-
audit
public static void audit(String auditProfile, @Nullable Date eventTimestamp, @Nullable String actor, @Nullable String actorHost, @Nullable String action, @Nullable String actionTarget, @Nullable String actionValue, @Nullable Integer statusCode, @Nullable Integer originatingContext, @Nullable List<String> originatingSystem, @Nullable String previousValue) throws Exception Client/designer-scope entry point for the audit-write RPC. Delegates straight through toAUDIT_RPC; it exists so callers (the designer/Vision-clientsystem.util.audit()binding) reach the write path through a static method that can be stubbed in tests, rather than referencing thestatic finalRPC proxy directly.- Throws:
Exception
-
sendEmail
-
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
-
runTagDensityQuery
public static Dataset runTagDensityQuery(Collection<? extends Path> paths, Date startDate, Date endDate) throws GatewayException - Throws:
GatewayException
-