Coveo ResultAttachments Component (CoveoResultAttachments)

The ResultAttachments component renders attachments in a result set, for example when displaying emails. This component is usable inside a result template when there is an active Folding component in the page.

This component is a result template component (see Result Templates).

Not supported in

Coveo for Salesforce Free

Index

Methods

Properties

Accessors

Component Options

Constructors

Methods

debugInfo

  • debugInfo(): any

disable

  • disable(): void

  • Disable the component. Normally this means that the component will not execute handlers for the framework events (query events, for example). Components are enabled by default on creation.

    Returns void

enable

  • enable(): void

  • Enable the component. Normally this means that the component will execute handlers for the framework events (query events, for example). Components are enabled by default on creation.

    Returns void

getBindings

Static get

  • get(element: HTMLElement, componentClass?: any, noThrow?: boolean): BaseComponent

  • Get the bound component to the given HTMLElement. Throws an assert if the HTMLElement has no component bound, unless using the noThrow argument.
    If there is multiple component bound to the current HTMLElement, you must specify the component class.

    Parameters

    • element: HTMLElement

      HTMLElement for which to get the bound component.

    • Optional componentClass: any

      Optional component class. If the HTMLElement has multiple components bound, you must specify which one you are targeting.

    • Optional noThrow: boolean

      Boolean option to tell the method to not throw on error.

    Returns BaseComponent

Properties

bind

bind: ComponentEvents

Allows the component to bind events and execute them only when it is enabled.

type

{Coveo.ComponentEvents}

componentOptionsModel

componentOptionsModel: ComponentOptionsModel

Contains the state of options for different components. Mainly used by ResultLink.

componentStateModel

componentStateModel: ComponentStateModel

Contains the state of different components (enabled vs disabled). Allows to get/set values. Triggers component state event when modified. Each component can listen to those events.

disabled

disabled: boolean

A disabled component will not participate in the query, or listen to ComponentEvents.

type

{boolean}

logger

logger: Logger

Allows component to log in the dev console.

queryController

queryController: QueryController

Contains the singleton that allows to trigger queries.

queryStateModel

queryStateModel: QueryStateModel

Contains the state of the query. Allows to get/set values. Trigger query state event when modified. Each component can listen to those events.

root

root: HTMLElement

A reference to the root HTMLElement (the SearchInterface).

searchInterface

searchInterface: SearchInterface

A reference to the root of every component, the SearchInterface.

Static ID

ID: string

The static ID that each component needs in order to be identified.
For example, SearchButton -> static ID: SearchButton -> className: CoveoSearchButton

Accessors

usageAnalytics

Component Options

maximumAttachmentLevel

maximumAttachmentLevel: number

Specifies the maximum nesting depth. Beyond this depth, the component stops rendering sub-attachments.

Default value is 5. Minimum value is 0.

Minimum

0

Default

5

Markup configuration example(s) :
data-maximum-attachment-level='10'

resultTemplate

resultTemplate: Template

Specifies the template to use to render each attachment for a top result.

You can specify a previously registered template to use either by referring to its HTML id attribute or to a CSS selector (see TemplateCache).

Examples:

Specifying a previously registered template by referring to its HTML id attribute:

<div class="CoveoResultAttachments" data-result-template-id="Foo"></div>

Specifying a previously registered template by referring to a CSS selector:

<div class='CoveoResultAttachments' data-result-template-selector=".Foo"></div>

If you do not specify a custom folding template, the component uses the default result attachment template.

subResultTemplate

subResultTemplate: Template

Specifies the template to use to render sub-attachments, which are attachments within attachments, for example when multiple files are embedded within a .zip attachment.

Sub-attachments can themselves contain sub-attachments, and so on up to a certain level (see the maximumAttachmentLevel option).

You can specify a previously registered template to use either by referring to its HTML id attribute or to a CSS selector (see TemplateCache).

Example:

Specifying a previously registered template by referring to its HTML id attribute:

<div class="CoveoResultAttachments" data-sub-result-template-id="Foo"></div>

Specifying a previously registered template by referring to a CSS selector:

<div class="CoveoResultAttachments" data-sub-result-template-selector=".Foo"></div>

By default, this option uses the same template you specify for the resultTemplate option.

Constructors

constructor

  • Creates a new ResultAttachments component.

    Parameters

    • element: HTMLElement

      The HTMLElement on which to instantiate the component.

    • Optional options: IResultAttachmentsOptions

      The options for the ResultAttachments component.

    • Optional bindings: IComponentBindings

      The bindings that the component requires to function normally. If not set, these will be automatically resolved (with a slower execution time).

    • Optional result: IQueryResult

      The result to associate the component with.

    • Default value attachmentLevel: number = 0

      The nesting depth.

    Returns ResultAttachments