Class SchemaService

Index

Constructors

Methods

invalidateAll invalidateProfile invalidateLayout isOfflineModeEnabled getFields getLayoutSchema

Constructors

constructor

new SchemaService(
    fmClient: FMClient,
    logger: Pick<Logger, "debug" | "info" | "warn" | "error">,
    options?: {
        getCacheTtlMs?: () => number;
        isMetadataEnabled?: () => boolean;
        offlineModeService?: OfflineModeService;
    },
): SchemaService
Parameters
- fmClient: FMClient
- logger: Pick<Logger, "debug" | "info" | "warn" | "error">
- Optionaloptions: {
      getCacheTtlMs?: () => number;
      isMetadataEnabled?: () => boolean;
      offlineModeService?: OfflineModeService;
  }
Returns SchemaService
- Defined in services/schemaService.ts:19

Methods

invalidateAll

invalidateAll(): void
Returns void
- Defined in services/schemaService.ts:38

invalidateProfile

invalidateProfile(profileId: string): void
Parameters
- profileId: string
Returns void
- Defined in services/schemaService.ts:42

invalidateLayout

invalidateLayout(profile: ConnectionProfile, layout: string): void
Parameters
- profile: ConnectionProfile
- layout: string
Returns void
- Defined in services/schemaService.ts:50

isOfflineModeEnabled

isOfflineModeEnabled(): boolean
Whether layouts are answered from the offline cache only, with no call to the server.

Returns boolean
- Defined in services/schemaService.ts:55

getFields

getFields(
profile: ConnectionProfile,
layout: string,
): Promise<SchemaMetadataResult>
Parameters
- profile: ConnectionProfile
- layout: string
Returns Promise<SchemaMetadataResult>
- Defined in services/schemaService.ts:59

getLayoutSchema

getLayoutSchema(
profile: ConnectionProfile,
layout: string,
): Promise<SchemaMetadataResult>
Parameters
- profile: ConnectionProfile
- layout: string
Returns Promise<SchemaMetadataResult>
- Defined in services/schemaService.ts:63