Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • ContentElementContext

Index

Constructors

constructor

Properties

Protected _appContext

_appContext: AppContext

The app context instance this component belongs to

Protected _children

The list of children of the current content element

Protected _data

_data: State

The given data we received from the server

Protected _errorHandler

The error handler to trigger errors for this content element

Protected _id

_id: string | number

The unique id of the content element this context belongs to

Protected _initialQuery

_initialQuery: JsonApiGetQuery

The initial state query object (only if configured from the backend element)

Protected _initialState

_initialState: Resource | Collection

The initial state object (only if configured from the backend element)

Protected _initialType

_initialType: string

The initial state's resource type

Accessors

appContext

axios

  • get axios(): AxiosInstance

children

data

eventEmitter

  • get eventEmitter(): EventEmitter
  • Returns the instance of the event emitter, for this framework instance The event emitter is used for global events that should be handled across multiple components

    Returns EventEmitter

id

  • get id(): string | number

initialQuery

initialState

initialType

  • get initialType(): string

pageContext

resourceApi

store

translation

type

  • get type(): string

Methods

emitError

  • emitError(reason: any, code?: number, additionalPayload?: PlainObject<any>): Promise<any>
  • This method can be used to emit an error for this content element. The error will be handled by the error handler class

    Parameters

    • reason: any
    • Optional code: number
    • Optional additionalPayload: PlainObject<any>

    Returns Promise<any>

Generated using TypeDoc