Optional
requestFactory: EventsApiRequestFactoryOptional
responseProcessor: EventsApiResponseProcessorThe timeline event definition.
Optional
_options: ConfigurationCreates multiple instances of timeline events based on an event template. Once created, these event are immutable on the object timeline and cannot be modified. If the event template was configured to update object properties via objectPropertyName
, this call will also attempt to updates those properties, or add them if they don't exist.
Creates multiple events
The timeline event definition.
Optional
_options: ConfigurationCreates multiple instances of timeline events based on an event template. Once created, these event are immutable on the object timeline and cannot be modified. If the event template was configured to update object properties via objectPropertyName
, this call will also attempt to updates those properties, or add them if they don't exist.
Creates multiple events
The timeline event definition.
Optional
_options: ConfigurationCreates an instance of a timeline event based on an event template. Once created, this event is immutable on the object timeline and cannot be modified. If the event template was configured to update object properties via objectPropertyName
, this call will also attempt to updates those properties, or add them if they don't exist.
Create a single event
The timeline event definition.
Optional
_options: ConfigurationThis returns the previously created event. It contains all existing info for the event, but not necessarily the CRM object. Gets the event
The event template ID.
The event ID.
Optional
_options: ConfigurationThis returns the previously created event. It contains all existing info for the event, but not necessarily the CRM object. Gets the event
The event template ID.
The event ID.
Optional
_options: ConfigurationThis will take the detailTemplate
from the event template and return an object rendering the specified event. If the template references extraData
that isn't found in the event, it will be ignored and we'll render without it.
Gets the detailTemplate as rendered
The event template ID.
The event ID.
Optional
_options: ConfigurationThis will take the detailTemplate
from the event template and return an object rendering the specified event. If the template references extraData
that isn't found in the event, it will be ignored and we'll render without it.
Gets the detailTemplate as rendered
The event template ID.
The event ID.
Optional
_options: ConfigurationThis will take either the headerTemplate
or detailTemplate
from the event template and render for the specified event as HTML. If the template references extraData
that isn't found in the event, it will be ignored and we'll render without it.
Renders the header or detail as HTML
The event template ID.
The event ID.
Optional
detail: booleanSet to 'true', we want to render the `detailTemplate` instead of the `headerTemplate`.
Optional
_options: ConfigurationThis will take either the headerTemplate
or detailTemplate
from the event template and render for the specified event as HTML. If the template references extraData
that isn't found in the event, it will be ignored and we'll render without it.
Renders the header or detail as HTML
The event template ID.
The event ID.
Optional
detail: booleanSet to 'true', we want to render the `detailTemplate` instead of the `headerTemplate`.
Optional
_options: Configuration
Creates an instance of a timeline event based on an event template. Once created, this event is immutable on the object timeline and cannot be modified. If the event template was configured to update object properties via
objectPropertyName
, this call will also attempt to updates those properties, or add them if they don't exist. Create a single event