Interface Context

The Context controller exposes methods for managing the global context in a commerce interface.

interface Context {
    state: ContextState;
    setCountry(country: string): void;
    setCurrency(currency: CurrencyCodeISO4217): void;
    setLanguage(language: string): void;
    setLocation(location: UserLocation): void;
    setView(view: View): void;
    subscribe(listener: () => void): Unsubscribe;
}

Hierarchy (View Summary)

Controller
- Context

Index

Methods

setCountry setCurrency setLanguage setLocation setView subscribe

Properties

Methods

setCountry

setCountry(country: string): void
Sets the country.
Parameters
- country: string
  The new country.
Returns void
- Defined in packages/headless/dist/definitions/controllers/commerce/context/headless-context.d.ts:40

setCurrency

setCurrency(currency: CurrencyCodeISO4217): void
Sets the currency.
Parameters
- currency: CurrencyCodeISO4217
  The new currency.
Returns void
- Defined in packages/headless/dist/definitions/controllers/commerce/context/headless-context.d.ts:45

setLanguage

setLanguage(language: string): void
Sets the language.
Parameters
- language: string
  The new language.
Returns void
- Defined in packages/headless/dist/definitions/controllers/commerce/context/headless-context.d.ts:35

setLocation

setLocation(location: UserLocation): void
Sets the location.
Parameters
- location: UserLocation
  The new location.
Returns void
- Defined in packages/headless/dist/definitions/controllers/commerce/context/headless-context.d.ts:55

setView

setView(view: View): void
Sets the view.
Parameters
- view: View
  The new view.
Returns void
- Defined in packages/headless/dist/definitions/controllers/commerce/context/headless-context.d.ts:50

subscribe(listener: () => void): Unsubscribe
Adds a callback that's invoked on state change.
Parameters
- listener: () => void
  A callback that's invoked on state change.
Returns Unsubscribe
A function to remove the listener.
Inherited from Controller.subscribe
- Defined in packages/headless/dist/definitions/controllers/controller/headless-controller.d.ts:10

Properties

state

state: ContextState

A scoped and simplified part of the headless state that is relevant to the Context controller.