Constructors

Methods

  • 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

    Parameters

    Returns Promise<TimelineEventResponse>

  • 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

    Parameters

    Returns Promise<HttpInfo<TimelineEventResponse>>

  • This 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

    Parameters

    • eventTemplateId: string

      The event template ID.

    • eventId: string

      The event ID.

    • Optional_options: Configuration

    Returns Promise<EventDetail>

  • This 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

    Parameters

    • eventTemplateId: string

      The event template ID.

    • eventId: string

      The event ID.

    • Optional_options: Configuration

    Returns Promise<HttpInfo<EventDetail>>

  • This 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

    Parameters

    • eventTemplateId: string

      The event template ID.

    • eventId: string

      The event ID.

    • Optionaldetail: boolean

      Set to &#39;true&#39;, we want to render the `detailTemplate` instead of the `headerTemplate`.

    • Optional_options: Configuration

    Returns Promise<string>

  • This 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

    Parameters

    • eventTemplateId: string

      The event template ID.

    • eventId: string

      The event ID.

    • Optionaldetail: boolean

      Set to &#39;true&#39;, we want to render the `detailTemplate` instead of the `headerTemplate`.

    • Optional_options: Configuration

    Returns Promise<HttpInfo<string>>

MMNEPVFCICPMFPCPTTAAATR