/** * @deprecated * As of TeamsJS v2.0.0, please use {@link pages.config} module instead. * * Module to interact with the settings-specific part of the SDK. * This object is usable only on the settings frame. * @module */ import * as pages from './pages/pages'; /** Register on remove handler function type */ export type registerOnRemoveHandlerFunctionType = (evt: RemoveEvent) => void; /** Register on save handler function type */ export type registerOnSaveHandlerFunctionType = (evt: SaveEvent) => void; /** Set settings on complete function type */ export type setSettingsOnCompleteFunctionType = (status: boolean, reason?: string) => void; /** Get settings callback function type */ export type getSettingsCallbackFunctionType = (instanceSettings: Settings) => void; /** * @deprecated * As of TeamsJS v2.0.0, please use {@link pages.config} instead. * @remarks * Renamed to config in pages.Config */ type Settings = pages.InstanceConfig; export { Settings }; /** * @deprecated * As of TeamsJS v2.0.0, please use {@link pages.config.SaveEvent} instead. * @remarks * See pages.SaveEvent */ type SaveEvent = pages.config.SaveEvent; export { SaveEvent }; /** * @deprecated * As of TeamsJS v2.0.0, please use {@link pages.config.RemoveEvent} instead. * @remarks * See pages.RemoveEvent */ type RemoveEvent = pages.config.RemoveEvent; export { RemoveEvent }; /** * @deprecated * As of TeamsJS v2.0.0, please use {@link pages.config.SaveParameters} instead. * @remarks * See pages.SaveParameters */ type SaveParameters = pages.config.SaveParameters; export { SaveParameters }; /** * @deprecated * As of TeamsJS v2.0.0, please use {@link pages.config.setValidityState pages.config.setValidityState(validityState: boolean): void} instead. * * Sets the validity state for the settings. * The initial value is false, so the user cannot save the settings until this is called with true. * * @param validityState - Indicates whether the save or remove button is enabled for the user. */ export declare function setValidityState(validityState: boolean): void; /** * @deprecated * As of TeamsJS v2.0.0, please use {@link pages.getConfig pages.getConfig(): Promise\} instead. * * Gets the settings for the current instance. * * @param callback - The callback to invoke when the {@link Settings} object is retrieved. */ export declare function getSettings(callback: getSettingsCallbackFunctionType): void; /** * @deprecated * As of TeamsJS v2.0.0, please use {@link pages.config.setConfig pages.config.setConfig(instanceSettings: Config): Promise\} instead. * * Sets the settings for the current instance. * This is an asynchronous operation; calls to getSettings are not guaranteed to reflect the changed state. * * @param - Set the desired settings for this instance. */ export declare function setSettings(instanceSettings: Settings, onComplete?: setSettingsOnCompleteFunctionType): void; /** * @deprecated * As of TeamsJS v2.0.0, please use {@link pages.config.registerOnSaveHandler pages.config.registerOnSaveHandler(handler: registerOnSaveHandlerFunctionType): void} instead. * * Registers a handler for when the user attempts to save the settings. This handler should be used * to create or update the underlying resource powering the content. * The object passed to the handler must be used to notify whether to proceed with the save. * Only one handler can be registered at a time. A subsequent registration replaces an existing registration. * * @param handler - The handler to invoke when the user selects the save button. */ export declare function registerOnSaveHandler(handler: registerOnSaveHandlerFunctionType): void; /** * @deprecated * As of TeamsJS v2.0.0, please use {@link pages.config.registerOnRemoveHandler pages.config.registerOnRemoveHandler(handler: registerOnRemoveHandlerFunctionType): void} instead. * * Registers a handler for user attempts to remove content. This handler should be used * to remove the underlying resource powering the content. * The object passed to the handler must be used to indicate whether to proceed with the removal. * Only one handler may be registered at a time. Subsequent registrations will override the first. * * @param handler - The handler to invoke when the user selects the remove button. */ export declare function registerOnRemoveHandler(handler: registerOnRemoveHandlerFunctionType): void;