public interface

SensitiveDataRule

com.salesforce.android.chat.core.model.SensitiveDataRule

Class Overview

Represents a text scrubbing directive that is used to replace or remove text that occurs in outgoing chat messages should they match the provided Regular Expression pattern.

Sensitive Data Rules are configurable for your Salesforce Organization and apply to all LiveAgent deployments.

Summary

Nested Classes
@interface SensitiveDataRule.Action  
Constants
String ACTION_REMOVE
String ACTION_REPLACE
Public Methods
abstract String getAction()
The action to perform when the text in a chat message matches the given pattern.
abstract String getId()
The Salesforce Object ID for the Sensitive Data Rule.
abstract String getName()
The name of the Sensitive Data Rule, as configured in your Salesforce Organization.
abstract Pattern[] getPatterns()
The Regular Expression patterns used to match sensitive data within each chat message.
abstract String getReplacement()
The optional replacement String to be used in place of matching text when the rule's Action is set to ACTION_REPLACE.

Constants

public static final String ACTION_REMOVE

Constant Value: "Remove"

public static final String ACTION_REPLACE

Constant Value: "Replace"

Public Methods

public abstract String getAction ()

The action to perform when the text in a chat message matches the given pattern.

Returns

public abstract String getId ()

The Salesforce Object ID for the Sensitive Data Rule.

Returns
  • ID for the rule.

public abstract String getName ()

The name of the Sensitive Data Rule, as configured in your Salesforce Organization.

Returns
  • The name of the rule.

public abstract Pattern[] getPatterns ()

The Regular Expression patterns used to match sensitive data within each chat message.

Returns
  • Pattern instances, as configured in your Salesforce Organization

public abstract String getReplacement ()

The optional replacement String to be used in place of matching text when the rule's Action is set to ACTION_REPLACE. This String may be a regex group replacement.

Returns
  • The replacement String for the rule, or an empty string if replacement is not applicable