Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Index

Properties

brEnvType?: string

Optional parameter specifying the Bloomreach environment type (e.g. STAGING) If the target is production, please do not specify this field.

brUid2?: string

The visitor's ID for brSM API calls.

connector?: string

If you want to use a different connector for the search (e.g. brsm), pass in the connector ID.

Optional Custom Query and Options Processor to update the original query document and variables if necessary

params?: ParamInput[]

Optional extra parameters that can be used by the backend.

smAccountId?: string

The 'account_id' parameter value to be passed to the brSM API calls if provided.

smAuthKey?: string

The 'auth_key' parameter value to be passed to the brSM API calls if provided.

smDomainKey?: string

The 'domain_key' parameter value to be passed to the brSM API calls if provided.

smViewId?: string

'view_id' parameter value to override in brSM API calls.

storeKey?: string

Optional store key information which may provide the context the customers shop in

Generated using TypeDoc