Options
All
  • Public
  • Public/Protected
  • All
Menu

Class App<SS>

This component acts as the main entry point for the trigger application. Based in its internal state, it renders the approriate content. Starting fresh, it renders a form which allows the user to start a new session by various means. Once a new session is started and thus a document ID is selected, the main trigger client with the events contained in the document is rendered. Moreover, should an AJAX error occur, this component also takes care or rendering an appropriate error message.

Type parameters

  • SS

Hierarchy

Index

Constructors

constructor

  • new App(props: never): App
  • Parameters

    • props: never

    Returns App

Properties

context

context: any

props

props: Readonly<object> & Readonly<__type>

refs

refs: object

Type declaration

  • [key: string]: ReactInstance

state

state: Readonly<AppState>

Methods

Optional UNSAFE_componentWillMount

  • UNSAFE_componentWillMount(): void

Optional UNSAFE_componentWillReceiveProps

  • UNSAFE_componentWillReceiveProps(nextProps: Readonly<__type>, nextContext: any): void

Optional UNSAFE_componentWillUpdate

  • UNSAFE_componentWillUpdate(nextProps: Readonly<__type>, nextState: Readonly<AppState>, nextContext: any): void

Private assignDocumentId

  • assignDocumentId(documentId: string): void
  • Initialises a new session by assigning a document ID to the component's internal state. Also stores the document ID in local storage so it is persisted between reloads.

    Parameters

    • documentId: string

      The document ID for this session

    Returns void

Private clearSession

  • clearSession(): void
  • Clears the session by setting the documentId property to null. Also removes the ID from local storage and clears the hash portion of the URL.

    Returns void

Optional componentDidCatch

  • componentDidCatch(error: Error, errorInfo: ErrorInfo): void
  • Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.

    Parameters

    • error: Error
    • errorInfo: ErrorInfo

    Returns void

componentDidMount

  • componentDidMount(): Promise<void>
  • Invoked after the component first mounts. Parses the query string and checks for presence of the keys triggerMode and url or documentId, which allow the user to directly assign a trigger mode and start a new session using the given (existing) document ID or URL.

    Returns Promise<void>

Optional componentDidUpdate

  • componentDidUpdate(prevProps: Readonly<__type>, prevState: Readonly<AppState>, snapshot?: SS): void
  • Called immediately after updating occurs. Not called for the initial render.

    The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.

    Parameters

    • prevProps: Readonly<__type>
    • prevState: Readonly<AppState>
    • Optional snapshot: SS

    Returns void

Optional componentWillMount

  • componentWillMount(): void

Optional componentWillReceiveProps

  • componentWillReceiveProps(nextProps: Readonly<__type>, nextContext: any): void

Optional componentWillUnmount

  • componentWillUnmount(): void
  • Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as cancelled network requests, or cleaning up any DOM elements created in componentDidMount.

    Returns void

Optional componentWillUpdate

  • componentWillUpdate(nextProps: Readonly<__type>, nextState: Readonly<AppState>, nextContext: any): void

forceUpdate

  • forceUpdate(callBack?: undefined | function): void
  • Parameters

    • Optional callBack: undefined | function

    Returns void

Optional getSnapshotBeforeUpdate

  • getSnapshotBeforeUpdate(prevProps: Readonly<__type>, prevState: Readonly<AppState>): SS | null
  • Runs before React applies the result of render to the document, and returns an object to be given to componentDidUpdate. Useful for saving things such as scroll position before render causes changes to it.

    Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated lifecycle events from running.

    Parameters

    • prevProps: Readonly<__type>
    • prevState: Readonly<AppState>

    Returns SS | null

render

  • render(): Element
  • Renders the component

    Returns Element

Private renderContent

  • renderContent(): Element
  • Renders the main content, which is different depending on various state variables.

    • If isLoading is true, a spinner is rendered
    • If ajaxError is set, an error message is rendered
    • If a documentId is set, render the main TriggerClient

    Otherwise the DocumentChooser component is rendered, where the user can start a new session.

    Returns Element

    The main content to be rendered

setState

  • setState<K>(state: function | null | S | object, callback?: undefined | function): void
  • Type parameters

    • K: keyof AppState

    Parameters

    • state: function | null | S | object
    • Optional callback: undefined | function

    Returns void

Optional shouldComponentUpdate

  • shouldComponentUpdate(nextProps: Readonly<__type>, nextState: Readonly<AppState>, nextContext: any): boolean
  • Called to determine whether the change in props and state should trigger a re-render.

    Component always returns true. PureComponent implements a shallow comparison on props and state and returns true if any props or states have changed.

    If false is returned, Component#render, componentWillUpdate and componentDidUpdate will not be called.

    Parameters

    • nextProps: Readonly<__type>
    • nextState: Readonly<AppState>
    • nextContext: any

    Returns boolean

Private triggerModeUpdated

  • Callback invoked to update the trigger mode. Updates the state accordingly and stores the new value in local storage.

    Parameters

    Returns void

Generated using TypeDoc