AnimationRule

Represents criteria for determining when an animation is displayed to Path users.

Where possible, we changed noninclusive terms to align with our company value of Equality. Because changing terms in our code can break current implementations, we maintained this object’s name.

Important

Version 

Introduced in API version 46.0.

Supported SOAP API Calls 

create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert()

Supported REST API Methods 

DELETE, GET, HEAD, PATCH, POST, Query

Fields 

AnimationFrequency 

• Type: picklist

• Required: No

• Properties: Filter, Group, Restricted picklist, Sort

• Introduced: API version 46.0

• Description: Required. The frequency with which an animation is displayed when a user selects the designated picklist values in a path. A value of always triggers an animation every time. The values often, sometimes, and rarely trigger an animation progressively less frequently.

• Possible values:

  • always — always

  • often — often

  • sometimes — sometimes

  • rarely — rarely

DeveloperName 

• Type: string

• Required: No

• Properties: Filter, Group, Sort

• Description: The developer name for the animation rule.

  Only users with View DeveloperName OR View Setup and Configuration permission can view, group, sort, and filter this field.

  Note

FullName 

• Type: string

• Required: No

• Properties: Create, Group, Nillable

• Introduced: API version 46.0

• Description: The full name of the associated metadata object in Metadata API.

Query this field only if the query result contains no more than one record. Otherwise, an error is returned. If more than one record exists, use multiple queries to retrieve the records. This limit protects performance.

IsActive 

• Type: boolean

• Required: No

• Properties: Defaulted on create, Filter, Group, Sort

• Description: Indicates whether the animation rule is active (true) or not (false).

• Default value: false

Language 

• Type: picklist

• Required: No

• Properties: Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort

• Description: The language in the user’s personal settings.

• Possible values:

  • en_US — English

  • de — German

  • es — Spanish

  • fr — French

  • it — Italian

  • ja — Japanese

  • sv — Swedish

  • ko — Korean

  • zh_TW — Chinese (Traditional)

  • zh_CN — Chinese (Simplified)

  • pt_BR — Portuguese (Brazil)

  • nl_NL — Dutch

  • da — Danish

  • th — Thai

  • fi — Finnish

  • ru — Russian

  • es_MX — Spanish (Mexico)

  • no — Norwegian

MasterLabel 

• Type: string

• Required: No

• Properties: Filter, Group, Sort

• Description: The label for the animation rule.

Metadata 

• Type: complexvalue

• Required: No

• Properties: Create, Nillable, Update

• Introduced: API version 46.0

• Description: AnimationRule metadata from the mns namespace.

Query this field only if the query result contains no more than one record. Otherwise, an error is returned. If more than one record exists, use multiple queries to retrieve the records. This limit protects performance.

RecordTypeContext 

• Type: picklist

• Required: No

• Properties: Filter, Group, Restricted picklist, Sort

• Introduced: API version 46.0

• Description: An enum to track whether this AnimationRule applies to all record types for the associated sObject, or only to a single or main record type. Valid values are All, Custom, and Master.

• Possible values:

  • All — All

  • Custom — Custom

  • Master — Master

SobjectType 

• Type: picklist

• Required: No

• Properties: Filter, Group, Restricted picklist, Sort

• Introduced: API version 46.0

• Description: The object on which the animation rule is run.

TargetField 

• Type: picklist

• Required: No

• Properties: Filter, Group, Restricted picklist, Sort

• Introduced: API version 46.0

• Description: Name of the field used to determine when to display an animation.

TargetFieldChangeToValues 

• Type: string

• Required: No

• Properties: Filter, Group, Sort

• Introduced: API version 46.0

• Description: Values used to determine when to display an animation. When a user selects a value in TargetField that matches a value stored in TargetFieldChangeToValues, the animation is displayed.