Engagement scoring factor contributed by an app, which supplies the dates on which a lead engaged so a score can be calculated. Registered through addEngagementScoringFactorType. Both the properties function and the engagement dates function may be given as a function name or as an actual JavaScript function. Each is called with a list to add its results to, rather than returning one.
Implements: EngagementScoringFactorType, Serializable
Properties
| Property | Returns | Description |
|---|---|---|
| id | String | Unique identifier for this scoring factor type, as given when the app registered it. |
| label | String | Human readable name shown when an administrator configures engagement scoring. |
| properties | List<EngagementScoringProperty> | Calls the app's properties function to collect the configurable properties of this scoring factor. Runs JavaScript against the app's engine, so it is not a plain field read, and returns an empty list if the function is missing or fails. |
Methods
getId()
Returns: String
Unique identifier for this scoring factor type, as given when the app registered it.
getLabel()
Returns: String
Human readable name shown when an administrator configures engagement scoring.
getProperties()
Returns: List<EngagementScoringProperty>
Calls the app's properties function to collect the configurable properties of this scoring factor. Runs JavaScript against the app's engine, so it is not a plain field read, and returns an empty list if the function is missing or fails.
engagementScoringProperty(String name, String title)
Returns: EngagementScoringProperty
Creates a new engagement scoring property for the app's properties function to add to its list. It is not registered anywhere by this call.
| Parameter | Description |
|---|---|
name | identifier of the property, used as the key its value is stored under |
title | label shown next to the property when the factor is configured |