Support Menu

Coveo component AuthenticationProvider

The AuthenticationProvider component arranges for queries to execute with an identity that the user obtains using an Authentication Provider configured on the Coveo Search API (see On-Premises SharePoint Claims Authentication).

When necessary, this component handles redirecting the browser to the address that starts the authentication process.

Using the standard data-tab attribute, you can enable the AuthenticationProvider component only for tabs requiring authentication (see Tab).

Index

Component Options

caption

caption: string

Specifies the friendly name of the authentication provider. This is the name that you want to display in the user interface when a user is logging in.

Default value is the value set to AuthenticationProvider.options.name.

Markup configuration example(s) :
data-caption='foo'

name

name: string

Specifies the name of the authentication provider.

See Windows Service Configuration File.

Markup configuration example(s) :
data-name='foo'

showIFrame

showIFrame: boolean

If the AuthenticationProvider.options.useIFrame is set to true, specifies whether to make the authentication <iframe> visible to the user (inside a popup).

Default value is true.

When the underlying authentication provider requires no user interaction (for example, when a user authenticates using Windows Authentication along with SharePoint Claims), setting this option to false reduces the visual impact of the authentication process.

Markup configuration example(s) :
data-show-i-frame='true'
data-show-i-frame='false'

useIFrame

useIFrame: boolean

Specifies whether to use an <iframe> to host the chain of redirections that make up the authentication process.

Default value is false.

Using an <iframe> prevents leaving the search page as part of the authentication process. However, some login providers will refuse to load in an <iframe>.

Markup configuration example(s) :
data-use-i-frame='true'
data-use-i-frame='false'

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). Component 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

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 differents component. Mainly used by ResultLink.

componentStateModel

componentStateModel: ComponentStateModel

Contains the state of different component (enabled vs disabled). Allows to get/set values. Trigger 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.

usageAnalytics

usageAnalytics: IAnalyticsClient

A reference to the Analytics.client.

Static ID

ID: string

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

Constructors

constructor