mirror of
https://github.com/gosticks/DefinitelyTyped.git
synced 2026-08-12 13:00:19 +00:00
[office-runtime] remove APIs that were moved to Office namespace or just deprecated (#43861)
This commit is contained in:
Vendored
-91
@@ -18,97 +18,6 @@ Copyright (c) Microsoft Corporation
|
||||
* Office runtime namespace.
|
||||
*/
|
||||
declare namespace OfficeRuntime {
|
||||
/**
|
||||
* Encapsulates methods that interact with the Office UI.
|
||||
* @beta
|
||||
*/
|
||||
interface UI {
|
||||
/**
|
||||
* Get the ribbon of the Office application.
|
||||
*/
|
||||
getRibbon(): Promise<Ribbon>;
|
||||
}
|
||||
/**
|
||||
* Encapsulates the management of the Office ribbon state.
|
||||
* @beta
|
||||
*/
|
||||
interface Ribbon {
|
||||
/**
|
||||
* Stages the updates to be made to the ribbon.
|
||||
* Note that this API only requests an update. The actual UI update to the ribbon is controlled by the
|
||||
* Office application and hence the exact timing of the ribbon update (or refresh) cannot be determined
|
||||
* by the completion of this API.
|
||||
* @param input Represents the updates to be made to the ribbon. Note that the only changes made to the ribbon
|
||||
* are those specified in the input parameter. In all other respects, the ribbon is not changed.
|
||||
*/
|
||||
requestUpdate(input: RibbonUpdaterData): Promise<void>;
|
||||
}
|
||||
/**
|
||||
* Represents the parts of the ribbon that the call to `requestUpdate` will change.
|
||||
* @beta
|
||||
*/
|
||||
interface RibbonUpdaterData {
|
||||
/**
|
||||
* Array of the tabs whose state is set with a call to `requestUpdate`.
|
||||
*/
|
||||
tabs?: Tab [];
|
||||
}
|
||||
/**
|
||||
* Represents an individual tab and the state it should have.
|
||||
* @beta
|
||||
*/
|
||||
interface Tab {
|
||||
/**
|
||||
* Identifier of the tab as specified in the manifest.
|
||||
*/
|
||||
id: string;
|
||||
/**
|
||||
* Represents an array of controls in the tab whose state is set with the call to `requestUpdate`.
|
||||
*/
|
||||
controls?: Control[];
|
||||
}
|
||||
/**
|
||||
* Represent an individual control or command whose state is set with the call to `requestUpdate`.
|
||||
* @beta
|
||||
*/
|
||||
interface Control {
|
||||
/**
|
||||
* Identifier of the control as specified in the manifest.
|
||||
*/
|
||||
id: string;
|
||||
/**
|
||||
* Indicates whether the control should be enabled (default) or disabled.
|
||||
*/
|
||||
enabled?: boolean;
|
||||
}
|
||||
/**
|
||||
* Represent an individual gallery control.
|
||||
* @beta
|
||||
*/
|
||||
interface Gallery extends Control {
|
||||
/**
|
||||
* Used to refresh a gallery control including optional data to be passed to the gallery control at the time of refresh action.
|
||||
*/
|
||||
refreshData?: {};
|
||||
}
|
||||
/**
|
||||
* Represents an individual menu item whose state is set with the call to `requestUpdate`.
|
||||
* @beta
|
||||
*/
|
||||
interface MenuControl {
|
||||
/**
|
||||
* Identifier of the menu item as specified in the manifest.
|
||||
*/
|
||||
id?: string;
|
||||
/**
|
||||
* The position of the item in the menu.
|
||||
*/
|
||||
position?: number;
|
||||
/**
|
||||
* Indicates whether the menu item should be enabled (default) or disabled.
|
||||
*/
|
||||
enabled?: boolean;
|
||||
}
|
||||
/**
|
||||
* Method that enables a pop up web dialog box.
|
||||
*
|
||||
|
||||
Reference in New Issue
Block a user