Project: Backstage (App Definition and Development / Application Definition & Image Build)
File: api-report.md

Do not edit this file. It is a report generated by . ```ts /// <reference types="react" /> import { ApiRef } from '@backstage/core-plugin-api'; import { BackstagePlugin } from '@backstage/core-plugin-api'; import { BackstageUserIdentity } from '@backstage/core-plugin-api'; import { DiscoveryApi } from '@backstage/core-plugin-api'; import { ErrorApi } from '@backstage/core-plugin-api'; import { FetchApi } from '@backstage/core-plugin-api'; import { IconComponent } from '@backstage/core-plugin-api'; import { IdentityApi } from '@backstage/core-plugin-api'; import { JsonValue } from '@backstage/types'; import { JSX as JSX_2 } from 'react'; import { Observable } from '@backstage/types'; import { ProfileInfo } from '@backstage/core-plugin-api'; import { ProfileInfoApi } from '@backstage/core-plugin-api'; import { PropsWithChildren } from 'react'; import { default as React_2 } from 'react'; import { RouteRef } from '@backstage/core-plugin-api'; import { SessionApi } from '@backstage/core-plugin-api'; import { StorageApi } from '@backstage/core-plugin-api'; import { StorageValueSnapshot } from '@backstage/core-plugin-api'; import { TabProps } from '@material-ui/core/Tab'; // @public (undocumented) export const DefaultProviderSettings: (props: { configuredProviders: string[]; }) => React_2.JSX.Element; // @public (undocumented) export const ProviderSettingsItem: (props: { title: string; description: string; icon: IconComponent; apiRef: ApiRef<ProfileInfoApi & SessionApi>; }) => React_2.JSX.Element; // @public (undocumented) export const Router: (props: { providerSettings?: JSX.Element; }) => React_2.JSX.Element; // @public (undocumented) export const Settings: (props: { icon?: IconComponent }) => React_2.JSX.Element; // @public (undocumented) export const SettingsLayout: { (props: SettingsLayoutProps): React_2.JSX.Element; Route: (props: SettingsLayoutRouteProps) => null; }; // @public (undocumented) export type SettingsLayoutProps = { title?: string; subtitle?: string; children?: React_2.ReactNode; }; // @public (undocumented) export type SettingsLayoutRouteProps = { path: string; title: string; children: JSX.Element; tabProps?: TabProps< React_2.ElementType, { component?: React_2.ElementType; } >; }; // @public @deprecated (undocumented) export const USERSETTINGSTAB_KEY = 'plugin.user-settings.settingsLayoutRoute'; // @public (undocumented) export const UserSettingsAppearanceCard: () => React_2.JSX.Element; // @public (undocumented) export const UserSettingsAuthProviders: (props: { providerSettings?: JSX.Element; }) => React_2.JSX.Element; // @public (undocumented) export const UserSettingsFeatureFlags: () => React_2.JSX.Element; // @public (undocumented) export const UserSettingsGeneral: () => React_2.JSX.Element; // @public (undocumented) export const UserSettingsIdentityCard: () => React_2.JSX.Element; // @public (undocumented) export const UserSettingsLanguageToggle: () => React_2.JSX.Element | null; // @public (undocumented) export const UserSettingsMenu: () => React_2.JSX.Element; // @public (undocumented) export const UserSettingsPage: (props: { providerSettings?: JSX.Element | undefined; }) => JSX_2.Element; // @public (undocumented) export const UserSettingsPinToggle: () => React_2.JSX.Element; // @public (undocumented) const userSettingsPlugin: BackstagePlugin< { settingsPage: RouteRef<undefined>; }, {} ; export { userSettingsPlugin as plugin }; export { userSettingsPlugin }; // @public (undocumented) export const UserSettingsProfileCard: () => React_2.JSX.Element; // @public (undocumented) export const UserSettingsSignInAvatar: (props: { size?: number; }) => React_2.JSX.Element; // @public export class UserSettingsStorage implements StorageApi { // (undocumented) static create(options: { fetchApi: FetchApi; discoveryApi: DiscoveryApi; errorApi: ErrorApi; identityApi: IdentityApi; namespace?: string; }): UserSettingsStorage; // (undocumented) forBucket(name: string): StorageApi; // (undocumented) observe$<T extends JsonValue>( key: string, ): Observable<StorageValueSnapshot<T>>; // (undocumented) remove(key: string): Promise<void>; // (undocumented) set<T extends JsonValue>(key: string, data: T): Promise<void>; // (undocumented) snapshot<T extends JsonValue>(key: string): StorageValueSnapshot<T>; } // @public @deprecated export const UserSettingsTab: ( props: UserSettingsTabProps, ) => React_2.JSX.Element; // @public @deprecated (undocumented) export type UserSettingsTabProps = PropsWithChildren<{ path: string; title: string; }>; // @public (undocumented) export const UserSettingsThemeToggle: () => React_2.JSX.Element; // @public (undocumented) export const useUserProfile: () => | { profile: ProfileInfo; displayName: string; loading: boolean; backstageIdentity?: undefined; } | { profile: ProfileInfo; backstageIdentity: BackstageUserIdentity; displayName: string; loading: false; }; ```