Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IBaseNavigationRegistrationResponse

The response given after a IBaseNavigationRegistrationRequest.

A successful example registration response:

example

{
  type: 'basenav:register',
  status: 'success'
}

Hierarchy

  • IBaseNavigationRegistrationResponse

Index

Properties

Optional error

error: number

The error Id if it exists based off of NavigationRegistrationErrorReason.

Optional errorMessage

errorMessage: string

The error message if it existed.

status

status: string

The result of the registration call based on BASE_NAVIGATION_REGISTER_TYPE.

type

type: "basenav:register"

Generated using TypeDoc