azure-devops-extension-api
Advanced tools
Comparing version 0.142.3 to 0.142.4
import { BuildDefinitionReference, BuildReference } from "./Build"; | ||
/** | ||
* Contribution ids of Azure Pipelines services which can be obtained from DevOps.getService | ||
*/ | ||
export const enum BuildServiceIds { | ||
export declare const enum BuildServiceIds { | ||
/** | ||
@@ -13,3 +11,2 @@ * Service for getting contextual information when on a builds page | ||
} | ||
/** | ||
@@ -19,3 +16,2 @@ * Contextual information for a build page | ||
export interface IBuildPageData { | ||
/** | ||
@@ -25,3 +21,2 @@ * The currently selected build result when on a build page | ||
build?: BuildReference; | ||
/** | ||
@@ -32,3 +27,2 @@ * The currently selected build definition when on a build page | ||
} | ||
/** | ||
@@ -38,3 +32,2 @@ * Service for getting contextual information when on a builds page | ||
export interface IBuildPageDataService { | ||
/** | ||
@@ -44,2 +37,2 @@ * Gets contextual information for a build page | ||
getBuildPageData(): IBuildPageData | undefined; | ||
} | ||
} |
/** | ||
* Contribution ids of core DevOps services which can be obtained from DevOps.getService | ||
*/ | ||
export const enum CommonServiceIds { | ||
export declare const enum CommonServiceIds { | ||
/** | ||
@@ -10,3 +9,2 @@ * Service for interacting with the extension data service | ||
ExtensionDataService = "ms.vss-features.extension-data-service", | ||
/** | ||
@@ -16,3 +14,2 @@ * Service for showing global message banners at the top of the page | ||
GlobalMessagesService = "ms.vss-tfs-web.tfs-global-messages-service", | ||
/** | ||
@@ -22,3 +19,2 @@ * Service for opening dialogs in the host frame | ||
HostDialogService = "ms.vss-features.host-dialog-service", | ||
/** | ||
@@ -28,3 +24,2 @@ * Service for interacting with the host window's navigation (URLs, new windows, etc.) | ||
HostNavigationService = "ms.vss-features.host-navigation-service", | ||
/** | ||
@@ -34,3 +29,2 @@ * Service for opening panels in the host frame | ||
HostPanelService = "ms.vss-features.host-panel-service", | ||
/** | ||
@@ -40,3 +34,2 @@ * Service for getting URLs/locations from the host context | ||
LocationService = "ms.vss-features.location-service", | ||
/** | ||
@@ -47,3 +40,2 @@ * Exposes project-related information from the current page | ||
} | ||
/** | ||
@@ -53,3 +45,2 @@ * Service for interacting with the host window's navigation (URLs, new windows, etc.) | ||
export interface IHostNavigationService { | ||
/** | ||
@@ -61,3 +52,2 @@ * Add a callback to be invoked each time the hash navigation has changed | ||
onHashChanged(callback: (hash: string) => void): void; | ||
/** | ||
@@ -67,3 +57,2 @@ * Gets the current hash. | ||
getHash(): Promise<string>; | ||
/** | ||
@@ -73,3 +62,2 @@ * Sets the provided hash from the hosted content. | ||
setHash(hash: string): void; | ||
/** | ||
@@ -79,3 +67,2 @@ * Replace existing hash with the provided hash from the hosted content. | ||
replaceHash(hash: string): void; | ||
/** | ||
@@ -87,3 +74,2 @@ * Update the host document's title (appears as the browser tab title). | ||
setDocumentTitle(title: string): void; | ||
/** | ||
@@ -93,3 +79,2 @@ * Reloads the parent frame | ||
reload(): void; | ||
/** | ||
@@ -101,3 +86,2 @@ * Navigate the parent page to the specified url | ||
navigate(url: string): void; | ||
/** | ||
@@ -111,7 +95,6 @@ * Open a new window to the specified url | ||
} | ||
/** | ||
* Host level for a VSS service | ||
*/ | ||
export const enum TeamFoundationHostType { | ||
export declare const enum TeamFoundationHostType { | ||
/** | ||
@@ -121,3 +104,2 @@ * The Deployment host | ||
Deployment = 1, | ||
/** | ||
@@ -127,3 +109,2 @@ * The Enterprise host | ||
Enterprise = 2, | ||
/** | ||
@@ -134,3 +115,2 @@ * The organization/project collection host | ||
} | ||
/** | ||
@@ -140,10 +120,8 @@ * Service for external content to get locations | ||
export interface ILocationService { | ||
/** | ||
* Gets the URL for the given REST resource area | ||
* | ||
* Gets the URL for the given REST resource area | ||
* | ||
* @param resourceAreaId - Id of the resource area | ||
*/ | ||
getResourceAreaLocation(resourceAreaId: string): Promise<string>; | ||
/** | ||
@@ -156,3 +134,2 @@ * Gets the location of a remote service at a given host type. | ||
getServiceLocation(serviceInstanceType?: string, hostType?: TeamFoundationHostType): Promise<string>; | ||
/** | ||
@@ -162,5 +139,5 @@ * Attemps to create a url for the specified route template and paramaters. The url will include host path. | ||
* the output will be /foo/bar/_admin. | ||
* | ||
* | ||
* This will asynchronously fetch a route contribution if it has not been included in page data. | ||
* | ||
* | ||
* @param routeId - Id of the route contribution | ||
@@ -170,5 +147,6 @@ * @param routeValues - Route value replacements | ||
*/ | ||
routeUrl(routeId: string, routeValues?: { [key: string]: string }, hostPath?: string): Promise<string>; | ||
routeUrl(routeId: string, routeValues?: { | ||
[key: string]: string; | ||
}, hostPath?: string): Promise<string>; | ||
} | ||
/** | ||
@@ -178,3 +156,2 @@ * Options for showing host dialogs | ||
export interface IDialogOptions<TResult> { | ||
/** | ||
@@ -184,3 +161,2 @@ * Dialog title | ||
title?: string; | ||
/** | ||
@@ -190,3 +166,2 @@ * Callback invoked when the dialog is closed | ||
onClose?: (result: TResult | undefined) => void; | ||
/** | ||
@@ -197,3 +172,2 @@ * Optional initial configuration for the dialog content | ||
} | ||
/** | ||
@@ -203,3 +177,2 @@ * Options for showing a message dialog | ||
export interface IMessageDialogOptions extends IDialogOptions<boolean> { | ||
/** | ||
@@ -209,3 +182,2 @@ * If true, show the cancel button | ||
showCancel?: boolean; | ||
/** | ||
@@ -215,3 +187,2 @@ * Custom text for the OK button | ||
okText?: string; | ||
/** | ||
@@ -222,3 +193,2 @@ * Custom text for the Cancel button | ||
} | ||
/** | ||
@@ -228,6 +198,5 @@ * Service for external content to show dialogs in the host frame | ||
export interface IHostDialogService { | ||
/** | ||
* Open a dialog in the host frame, showing custom external content | ||
* | ||
* | ||
* @param contentContributionId - Id of the dialog content contribution that specifies the content to display in the dialog. | ||
@@ -237,6 +206,5 @@ * @param options - Dialog options | ||
openCustomDialog: <TResult>(contentContributionId: string, options?: IDialogOptions<TResult>) => void; | ||
/** | ||
* Open a dialog in the host frame, showing the specified text message, an OK and optional Cancel button | ||
* | ||
* | ||
* @param message - Dialog message text | ||
@@ -247,12 +215,10 @@ * @param options - Dialog options | ||
} | ||
/** | ||
* Size (width) options for panel | ||
*/ | ||
export const enum PanelSize { | ||
export declare const enum PanelSize { | ||
Small = 0, | ||
Medium = 1, | ||
Large = 2, | ||
Large = 2 | ||
} | ||
/** | ||
@@ -262,3 +228,2 @@ * Options for showing panels | ||
export interface IPanelOptions<TResult> { | ||
/** | ||
@@ -268,3 +233,2 @@ * Callback invoked when the dialog is closed | ||
onClose?: (result: TResult | undefined) => void; | ||
/** | ||
@@ -274,3 +238,2 @@ * The panel title you want to display. | ||
title?: string; | ||
/** | ||
@@ -280,3 +243,2 @@ * Optional, description of panel. | ||
description?: string; | ||
/** | ||
@@ -286,3 +248,2 @@ * Size of the panel. (defaults to PanelSize.Medium) | ||
size?: PanelSize; | ||
/** | ||
@@ -293,3 +254,2 @@ * Optional initial configuration for the panel content | ||
} | ||
/** | ||
@@ -299,6 +259,5 @@ * Service for external content to show a panel in the host frame | ||
export interface IHostPanelService { | ||
/** | ||
* Open a panel in the host frame, showing custom external content | ||
* | ||
* | ||
* @param contentContributionId - Id of the panel content contribution that specifies the content to display in the panel. | ||
@@ -309,3 +268,2 @@ * @param options - Panel display options | ||
} | ||
/** | ||
@@ -315,3 +273,2 @@ * Interface for options that can be supplied with document actions | ||
export interface IDocumentOptions { | ||
/** | ||
@@ -321,3 +278,2 @@ * The scope of where the document is stored. Can be Default or User. | ||
scopeType?: string; | ||
/** | ||
@@ -327,3 +283,2 @@ * The value of the scope where the document is stored. Can be Current or Me. | ||
scopeValue?: string; | ||
/** | ||
@@ -335,3 +290,2 @@ * The default value to return when using getValue(). If the document has no value, | ||
} | ||
/** | ||
@@ -358,5 +312,3 @@ * Represents a single collection for extension data documents | ||
} | ||
export interface IExtensionDataManager { | ||
/** | ||
@@ -369,3 +321,2 @@ * Returns a promise for retrieving a setting at the provided key and scope | ||
getValue<T>(key: string, documentOptions?: IDocumentOptions): Promise<T>; | ||
/** | ||
@@ -379,3 +330,2 @@ * Returns a promise for saving a setting at the provided key and scope | ||
setValue<T>(key: string, value: T, documentOptions?: IDocumentOptions): Promise<T>; | ||
/** | ||
@@ -389,3 +339,2 @@ * Returns a promise for getting a document with the provided id in the provided collection | ||
getDocument(collectionName: string, id: string, documentOptions?: IDocumentOptions): Promise<any>; | ||
/** | ||
@@ -398,3 +347,2 @@ * Returns a promise for getting all of the documents in the provided collection | ||
getDocuments(collectionName: string, documentOptions?: IDocumentOptions): Promise<any[]>; | ||
/** | ||
@@ -408,3 +356,2 @@ * Returns a promise for creating a document in the provided collection | ||
createDocument(collectionName: string, doc: any, documentOptions?: IDocumentOptions): Promise<any>; | ||
/** | ||
@@ -419,3 +366,2 @@ * Returns a promise for setting a document in the provided collection | ||
setDocument(collectionName: string, doc: any, documentOptions?: IDocumentOptions): Promise<any>; | ||
/** | ||
@@ -430,3 +376,2 @@ * Returns a promise for updating a document in the provided collection | ||
updateDocument(collectionName: string, doc: any, documentOptions?: IDocumentOptions): Promise<any>; | ||
/** | ||
@@ -440,3 +385,2 @@ * Returns a promise for deleting the document at the provided scope, collection and id | ||
deleteDocument(collectionName: string, id: string, documentOptions?: IDocumentOptions): Promise<void>; | ||
/** | ||
@@ -448,3 +392,2 @@ * Returns a promise for querying a set of collections | ||
queryCollectionsByName(collectionNames: string[]): Promise<ExtensionDataCollection[]>; | ||
/** | ||
@@ -457,8 +400,6 @@ * Returns a promise for querying a set of collections | ||
} | ||
export interface IExtensionDataService { | ||
/** | ||
* Gets a class that can be used to manage extension data. | ||
* | ||
* | ||
* @param extensionId - Id of the extension (publisher.extension) | ||
@@ -469,5 +410,3 @@ * @param accessToken - Access token to use for the extension | ||
} | ||
export interface IProjectInfo { | ||
/** | ||
@@ -477,3 +416,2 @@ * Unique identifier (GUID) of the project | ||
id: string; | ||
/** | ||
@@ -484,5 +422,3 @@ * Name of the project | ||
} | ||
export interface IProjectPageService { | ||
/** | ||
@@ -493,5 +429,3 @@ * Gets the project associated with the current page | ||
} | ||
export interface IGlobalMessageLink { | ||
/** | ||
@@ -501,3 +435,2 @@ * Hyperlink text | ||
name: string; | ||
/** | ||
@@ -508,4 +441,3 @@ * Url of the link target | ||
} | ||
export const enum MessageBannerLevel { | ||
export declare const enum MessageBannerLevel { | ||
info = 0, | ||
@@ -516,5 +448,3 @@ warning = 1, | ||
} | ||
export interface IGlobalMessageBanner { | ||
/** | ||
@@ -524,3 +454,2 @@ * banner level (controls the background and icon of the banner) | ||
level?: MessageBannerLevel; | ||
/** | ||
@@ -530,3 +459,2 @@ * Banner message. Ignored if messageFormat is also provided | ||
message?: string; | ||
/** | ||
@@ -536,3 +464,2 @@ * Banner message format string. Arguments (like \{0\}, \{1\} are filled in with hyperlinks supplied in messageLinks) | ||
messageFormat?: string; | ||
/** | ||
@@ -543,11 +470,9 @@ * Links to supply to the format arguments in `messageFormat` | ||
} | ||
export interface IGlobalMessagesService { | ||
/** | ||
* Sets the currently displayed global message banner | ||
* | ||
* | ||
* @param banner - The message banner to display | ||
*/ | ||
setGlobalMessageBanner(banner: IGlobalMessageBanner): void | ||
} | ||
setGlobalMessageBanner(banner: IGlobalMessageBanner): void; | ||
} |
@@ -1,8 +0,2 @@ | ||
/* | ||
* --------------------------------------------------------- | ||
* Copyright(C) Microsoft Corporation. All rights reserved. | ||
* --------------------------------------------------------- | ||
*/ | ||
export const enum DayOfWeek { | ||
export declare const enum DayOfWeek { | ||
/** | ||
@@ -35,3 +29,3 @@ * Indicates Sunday. | ||
*/ | ||
Saturday = 6, | ||
} | ||
Saturday = 6 | ||
} |
@@ -1,11 +0,5 @@ | ||
/* | ||
* --------------------------------------------------------- | ||
* Copyright(C) Microsoft Corporation. All rights reserved. | ||
* --------------------------------------------------------- | ||
*/ | ||
/** | ||
* Specifies SQL Server-specific data type of a field, property, for use in a System.Data.SqlClient.SqlParameter. | ||
*/ | ||
export const enum SqlDbType { | ||
export declare const enum SqlDbType { | ||
/** | ||
@@ -135,2 +129,2 @@ * A 64-bit signed integer. | ||
DateTimeOffset = 34 | ||
} | ||
} |
{ | ||
"name": "azure-devops-extension-api", | ||
"version": "0.142.3", | ||
"version": "0.142.4", | ||
"description": "REST client libraries and contracts for Azure DevOps web extension developers.", | ||
@@ -5,0 +5,0 @@ "repository": { |
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
3192541
322
69364