Backstage
    Preparing search index...

    Module index

    Core API used by Backstage plugins

    Namespaces

    FeatureFlagState
    SessionState

    Interfaces

    ElementCollection
    FeatureFlagsApi
    StorageApi

    Type Aliases

    AlertApi
    AlertMessage
    AnalyticsApi
    AnalyticsContextValue
    AnalyticsEvent
    AnalyticsEventAttributes
    AnalyticsTracker
    AnyApiFactory
    AnyApiRef
    AnyExternalRoutes
    AnyParams
    AnyRouteRefParams
    AnyRoutes
    ApiFactory
    ApiHolder
    ApiRef
    ApiRefConfig
    AppComponents
    AppContext
    AppTheme
    AppThemeApi
    AuthProviderInfo
    AuthRequestOptions
    BackstageIdentityApi
    BackstageIdentityResponse
    BackstagePlugin
    BackstageUserIdentity
    BootErrorPageProps
    CommonAnalyticsContext
    ComponentLoader
    ConfigApi
    DiscoveryApi
    ErrorApi
    ErrorApiError
    ErrorApiErrorContext
    ErrorBoundaryFallbackProps
    Extension
    ExternalRouteRef
    FeatureFlag
    FeatureFlagsHooks
    FeatureFlagsSaveOptions
    FeatureFlagState
    FetchApi
    IconComponent
    IdentityApi
    MakeSubRouteRef
    MergeParams
    OAuthApi
    OAuthRequestApi
    OAuthRequester
    OAuthRequesterOptions
    OAuthScope
    OpenIdConnectApi
    OptionalParams
    ParamKeys
    ParamNames
    ParamPart
    PathParams
    PendingOAuthRequest
    PluginConfig
    PluginFeatureFlagConfig
    ProfileInfo
    ProfileInfoApi
    RouteFunc
    RouteRef
    SessionApi
    SessionState
    SignInPageProps
    StorageValueSnapshot
    SubRouteRef
    TypesToApiRefs

    Variables

    alertApiRef
    analyticsApiRef
    appThemeApiRef
    atlassianAuthApiRef
    bitbucketAuthApiRef
    bitbucketServerAuthApiRef
    configApiRef
    discoveryApiRef
    errorApiRef
    featureFlagsApiRef
    FeatureFlagState
    fetchApiRef
    githubAuthApiRef
    gitlabAuthApiRef
    googleAuthApiRef
    identityApiRef
    microsoftAuthApiRef
    oauthRequestApiRef
    oktaAuthApiRef
    oneloginAuthApiRef
    openshiftAuthApiRef
    SessionState
    storageApiRef
    vmwareCloudAuthApiRef

    Functions

    AnalyticsContext
    attachComponentData
    createApiFactory
    createApiRef
    createComponentExtension
    createExternalRouteRef
    createPlugin
    createReactExtension
    createRoutableExtension
    createRouteRef
    createSubRouteRef
    getComponentData
    useAnalytics
    useApi
    useApiHolder
    useApp
    useElementFilter
    useRouteRef
    useRouteRefParams
    withApis

    Settings

    Member Visibility

    On This Page

    Namespaces
    Interfaces
    Type Aliases
    AlertApiAlertMessageAnalyticsApiAnalyticsContextValueAnalyticsEventAnalyticsEventAttributesAnalyticsTrackerAnyApiFactoryAnyApiRefAnyExternalRoutesAnyParamsAnyRouteRefParamsAnyRoutesApiFactoryApiHolderApiRefApiRefConfigAppComponentsAppContextAppThemeAppThemeApiAuthProviderInfoAuthRequestOptionsBackstageIdentityApiBackstageIdentityResponseBackstagePluginBackstageUserIdentityBootErrorPagePropsCommonAnalyticsContextComponentLoaderConfigApiDiscoveryApiErrorApiErrorApiErrorErrorApiErrorContextErrorBoundaryFallbackPropsExtensionExternalRouteRefFeatureFlagFeatureFlagsHooksFeatureFlagsSaveOptionsFeatureFlagStateFetchApiIconComponentIdentityApiMakeSubRouteRefMergeParamsOAuthApiOAuthRequestApiOAuthRequesterOAuthRequesterOptionsOAuthScopeOpenIdConnectApiOptionalParamsParamKeysParamNamesParamPartPathParamsPendingOAuthRequestPluginConfigPluginFeatureFlagConfigProfileInfoProfileInfoApiRouteFuncRouteRefSessionApiSessionStateSignInPagePropsStorageValueSnapshotSubRouteRefTypesToApiRefs
    Variables
    Functions