Package com.inductiveautomation.ignition.common.rpc.impl

Interface SwingRpc

public interface SwingRpc

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final record	SwingRpc.SwingSessionInfo

Method Summary

Modifier and Type	Method	Description
void	cancelTask(String uuid)
String	getExternalIp()
@NotNull List<SwingRpc.SwingSessionInfo>	getSessionInfo(@Nullable String usernameFilter, @Nullable String projectFilter)	Returns a list of currently active Designer and Vision client sessions, optionally matching provided filters.
void	reportError(String message, String details, String sysProps, String userDescription, String userName, String userContact)
void	sendEmail(@Nullable String smtpHost, @Nullable String smtpProfile, @Nullable List<String> recipients, @Nullable List<String> ccRecipients, @Nullable List<String> bccRecipients, @Nullable List<String> attachmentNames, @Nullable List<String> attachmentData, @Nullable String from, @Nullable String subject, @Nullable String body, @Nullable String contentType, @Nullable String username, @Nullable String password, @Nullable Integer providedTimeout, @Nullable String priority, @Nullable List<String> replyTo, @Nullable Integer providedRetries)
void	setSessionLocale(Locale locale)

Method Details

getExternalIp

String getExternalIp()

setSessionLocale

void setSessionLocale(Locale locale)

getSessionInfo

@NotNull
@NotNull List<SwingRpc.SwingSessionInfo> getSessionInfo(@Nullable
 @Nullable String usernameFilter,
 @Nullable
 @Nullable String projectFilter)

Returns a list of currently active Designer and Vision client sessions, optionally matching provided filters.

Parameters:

usernameFilter - the username filter, to be parsed into a regex pattern.

projectFilter - the project filter, to be parsed into a regex pattern.

reportError

void reportError(String message,
 String details,
 String sysProps,
 String userDescription,
 String userName,
 String userContact)

sendEmail

void sendEmail(@Nullable
 @Nullable String smtpHost,
 @Nullable
 @Nullable String smtpProfile,
 @Nullable
 @Nullable List<String> recipients,
 @Nullable
 @Nullable List<String> ccRecipients,
 @Nullable
 @Nullable List<String> bccRecipients,
 @Nullable
 @Nullable List<String> attachmentNames,
 @Nullable
 @Nullable List<String> attachmentData,
 @Nullable
 @Nullable String from,
 @Nullable
 @Nullable String subject,
 @Nullable
 @Nullable String body,
 @Nullable
 @Nullable String contentType,
 @Nullable
 @Nullable String username,
 @Nullable
 @Nullable String password,
 @Nullable
 @Nullable Integer providedTimeout,
 @Nullable
 @Nullable String priority,
 @Nullable
 @Nullable List<String> replyTo,
 @Nullable
 @Nullable Integer providedRetries)

Parameters:

smtpHost - A direct SMTP hostname to attempt to connect to (see username, password)

smtpProfile - An SMTP profile name to use for sending the email.

cancelTask

void cancelTask(String uuid)