azure-devops-extension-sdk package

Применение переменных темы к текущему документу

function applyTheme(themeData: {[varName: string]: string})

Параметры

Отключает мост аутентификации вложенных приложений. После этого вызова любые запросы на токены MSAL получат BridgeDisabled ошибку. Объект моста остаётся включённым window.nestedAppAuthBridge , чтобы существующие слушатели MSAL не остались сиротами. Позвоните enableNestedAppAuth() для повторного включения.

function disableNestedAppAuth()

Включите аутентификацию вложенных приложений (NAA) для этого расширения.

Настраивает window.nestedAppAuthBridge так, что MSAL createNestablePublicClientApplication могут делегировать получение токенов на Azure DevOps хост-фрейм. Это позволяет избежать проблем с кросс-оригингом BroadcastChannel, блокирующих аутентификация на основе всплывающих окон в iframes.

Называйте это после init() и до создания инстанса MSAL. Требуется, чтобы хост имел включённую поддержку NAA.

Пример

await SDK.init();
await SDK.enableNestedAppAuth();
const pca = await createNestablePublicClientApplication({
    auth: { clientId: "your-entra-client-id" }
});

function enableNestedAppAuth(): Promise<void>

Возвращаемое значение

Обещание, которое разрешается, когда мост готов, или отклоняется, если хост не поддерживает NAA.

Получение маркера доступа, который позволит выполнять вызовы к другим службам DevOps

function getAccessToken(): Promise<string>

Возвращаемое значение

Получение маркера, который можно использовать для идентификации текущего пользователя

function getAppToken(): Promise<string>

Возвращаемое значение

Получение данных конфигурации, переданных в начальном подтверждении из родительского кадра

function getConfiguration(): {[key: string]: any}

Возвращаемое значение

Возвращает сведения о вкладе, который сначала вызвал загрузку этого расширения.

function getContributionId(): string

Возвращаемое значение

Получение контекста о расширении, которому принадлежит содержимое, размещенное

function getExtensionContext(): IExtensionContext

Возвращаемое значение

Получает сведения о узле (т. е. организации Azure DevOps), на которую ориентирована страница.

function getHost(): IHostContext

Возвращаемое значение

Получение контекста о странице узла

function getPageContext(): IPageContext

Возвращаемое значение

Получите вклад с указанным идентификатором вклада. Возвращаемый вклад имеет метод получения зарегистрированного объекта в рамках этого вклада.

function getService<T>(contributionId: string): Promise<T>

Параметры

Возвращаемое значение

Получает сведения о команде, на которую ориентирована страница

function getTeamContext(): ITeamContext

Возвращаемое значение

Возвращает сведения о текущем пользователе

function getUser(): IUserContext

Возвращаемое значение

Получение контекста о Интернете

function getWebContext(): IWebContext

Возвращаемое значение

Инициирует подтверждение с помощью окна узла.

function init(options?: IExtensionInitOptions): Promise<void>

Параметры

Возвращаемое значение

Уведомляет узел о том, что расширение не удалось загрузить

function notifyLoadFailed(e: string | Error): Promise<void>

Параметры

Возвращаемое значение

Уведомляет узел о том, что расширение успешно загружено (остановите отображение индикатора загрузки)

function notifyLoadSucceeded(): Promise<void>

Возвращаемое значение

Зарегистрируйте обратный вызов, который вызывается после завершения начальной установки или подтверждения. Если начальная настройка уже завершена, обратный вызов вызывается в конце текущего стека вызовов.

function ready(): Promise<void>

Возвращаемое значение

Зарегистрируйте объект (метод экземпляра или фабрики), который этот расширение предоставляет кадру узла.

function register<T>(instanceId: string, instance: T)

Параметры

Запрашивает родительское окно, чтобы изменить размер контейнера для этого расширения на основе текущего размера расширения.

function resize(width?: number, height?: number)

Параметры

Удаляет объект, предоставляемый этим расширением для кадра узла.

function unregister(instanceId: string)

Параметры

Номер версии веб-SDK. Можно задать в наборе требований расширения, например: vss-sdk-version/4.2

sdkVersion: 5

Тип