Apex Reference Guide

Apex Reference Guide
Apex DML Operations
ApexPages Namespace
AppLauncher Namespace
Approval Namespace
Auth Namespace
Cache Namespace
Canvas Namespace
ChatterAnswers Namespace
CommercePayments Namespace
ConnectApi Namespace
Database Namespace
Datacloud Namespace
DataSource Namespace
Dom Namespace
EventBus Namespace
ExternalService Namespace
Flow Namespace
Functions Namespace
KbManagement Namespace
LxScheduler Namespace
Messaging Namespace
Metadata Namespace
Pref_center Namespace
Process Namespace
QuickAction Namespace
Reports Namespace
Schema Namespace
Search Namespace
Sfc Namespace
Sfdc_Checkout Namespace
sfdc_surveys Namespace
Site Namespace
Support Namespace
System Namespace
TerritoryMgmt Namespace
TxnSecurity Namespace
Event Class
Event Constructors
Event Properties
EventCondition Interface
AsyncCondition Interface
PolicyCondition Interface
UserProvisioning Namespace
VisualEditor Namespace
Wave Namespace
Appendices
PDF

Newer Version Available

This content describes an older version of this product. View Latest

Event Class

Contains event information that the evaluate method uses to evaluate a transaction security policy.

Namespace

Legacy Transaction Security is scheduled for retirement in all Salesforce orgs as of Summer ’20. For more information, see Legacy Transaction Security Retirement. To create transaction security policies using the new framework, refer to the Enhanced Transaction Security documentation. To migrate legacy policies to the new framework, refer to the migration documentation.

Warning

TxnSecurity

Usage

The Event class contains the information needed to determine if the event triggers a Transaction Security policy. Not all class attributes are used for every type of event.

For more functionality and support of Enhanced Transaction Security, use the EventCondition interface instead of the PolicyCondition interface.

Tip

Event Constructors

The following is the constructor for Event.

Event()

Creates an instance of the TxnSecurity.Event class.

Signature

public Event()

Event Properties

The following are properties for Event.

action

Specifies the action being taken on the resource for an Entity event. For example, a Login IP resource for an Entity event could have an action of create. The action attribute is not used by any other event type.

Signature

public String action {get; set;}

Property Value

Type: String

data

Contains data used by actions. For example, data for a login event includes the login history ID. Returns a map whose keys are the type of event data, like SourceIp.

Signature

public Map<String,String> data {get; set;}

Property Value

Type: Map<String, String>

The following table lists all the available data types. Not all types appear with all event types. The data type values are always string representations. For example, the isApi value is a string in the map, but is actually a Boolean value. Convert the value from a string to its true type this way: Boolean.valueOf(event.data.get('isApi'));
Key Name True Value Type Events Supported
ActionName String Values are:
  • Convert
  • Delete
  • Insert
  • Undelete
  • Update
  • Upsert
 Entity
ApiType String (Enum manifested as a String) DataExport, Login
Application String AccessResource, DataExport
ClientId String (ID of the client) DataExport
ConnectedAppId String (ID of the Connected App) AccessResource, DataExport
ExecutionTime milliseconds DataExport
IsApi Boolean DataExport
IsScheduled Boolean DataExport
LoginHistoryId String DataExport, Login
NumberOfRecords Integer DataExport
PolicyId String (ID of the current policy) All events
SessionLevel String (Enum manifested as a String. Values include STANDARD and HIGH_ASSURANCE) AccessResource
SourceIp String (IPV4 Address) AccessResource
UserName String Entity

entityId

The ID of any entity associated with the event. For example, the entityId of a DataExport event for an Account object contains the Account ID.

Signature

public String entityId {get; set;}

Property Value

Type: String

entityName

The name of the object the event acts on.

Signature

public String entityName {get; set;}

Property Value

Type: String

organizationId

The ID of the Salesforce org where the event occurred.

Signature

public String organizationId {get; set;}

Property Value

Type: String

resourceType

The type of resource for the event. For example, an AccessResource event could have a Connected Application as a resource type. Not all event types have resources.

Signature

public String resourceType {get; set;}

Property Value

Type: String

timeStamp

The time the event occurred.

Signature

public Datetime timeStamp {get; set;}

Property Value

Type: Datetime

userId

Identifies the user that caused the event.

Signature

public String userId {get; set;}

Property Value

Type: String