azure-devops-extension-sdk package

Stosuje zmienne motywu do bieżącego dokumentu

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

Parametry

Wyłącza most uwierzytelniania aplikacji zagnieżdżonej. Po tym wywołaniu każde żądanie tokenów MSAL otrzyma BridgeDisabled błąd. Obiekt mostka pozostaje włączony window.nestedAppAuthBridge , aby istniejący słuchacze MSAL nie zostali osieroceni. Zadzwoń, enableNestedAppAuth() aby ponownie włączyć.

function disableNestedAppAuth()

Włącz uwierzytelnianie zagnieżdżonych aplikacji (NAA) dla tego rozszerzenia.

Ustawia window.nestedAppAuthBridge się tak, aby MSAL createNestablePublicClientApplication mogły delegować pozyskiwanie tokenów do ramki hosta Azure DevOps. To zapobiega problemom z BroadcastChannel między źródłami, które blokują uwierzytelnianie na podstawie wyskakujących okienek w ramach iframe.

Nazywaj to po init() i przed utworzeniem instancji MSAL. Wymaga to od hosta włączenia wsparcia NAA.

Przykład

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

function enableNestedAppAuth(): Promise<void>

Zwraca

Obietnica, która rozwiązuje się, gdy most będzie gotowy, lub odrzuca, jeśli host nie obsługuje NAA.

Pobierz token dostępu, który umożliwi wykonywanie wywołań do innych usług DevOps

function getAccessToken(): Promise<string>

Zwraca

Pobierz token, którego można użyć do identyfikacji bieżącego użytkownika

function getAppToken(): Promise<string>

Zwraca

Pobierz dane konfiguracyjne przekazane w początkowym uzgadnianiu z ramki nadrzędnej

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

Zwraca

Pobiera informacje o współtworzeniu, który jako pierwszy spowodował załadowanie tego rozszerzenia.

function getContributionId(): string

Zwraca

Uzyskaj kontekst dotyczący rozszerzenia, które jest właścicielem hostowanej zawartości

function getExtensionContext(): IExtensionContext

Zwraca

Pobiera informacje o hoście (tj. organizacji usługi Azure DevOps), dla którego jest przeznaczona strona

function getHost(): IHostContext

Zwraca

Uzyskiwanie kontekstu dotyczącego strony hosta

function getPageContext(): IPageContext

Zwraca

Pobierz wkład z podanym identyfikatorem wkładu. Zwrócony wkład ma metodę uzyskania zarejestrowanego obiektu w ramach tego wkładu.

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

Parametry

Zwraca

Pobiera informacje o zespole, do którego kierowana jest strona.

function getTeamContext(): ITeamContext

Zwraca

Pobiera informacje o bieżącym użytkowniku

function getUser(): IUserContext

Zwraca

Zapoznaj się z kontekstem sieci Web

function getWebContext(): IWebContext

Zwraca

Inicjuje uzgadnianie z oknem hosta.

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

Parametry

Zwraca

Powiadamia hosta, że nie można załadować rozszerzenia

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

Parametry

Zwraca

Powiadamia hosta, że rozszerzenie zostało pomyślnie załadowane (przestaje wyświetlać wskaźnik ładowania)

function notifyLoadSucceeded(): Promise<void>

Zwraca

Zarejestruj wywołanie zwrotne, które zostanie wywołane po zakończeniu początkowej konfiguracji/uzgadniania. Jeśli początkowa konfiguracja została już ukończona, wywołanie zwrotne jest wywoływane na końcu bieżącego stosu wywołań.

function ready(): Promise<void>

Zwraca

Zarejestruj obiekt (instancję lub metodę wytwórczą), który to rozszerzenie uwidacznia w ramce hosta.

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

Parametry

Żąda od okna nadrzędnego zmiany rozmiaru kontenera dla tego rozszerzenia na podstawie bieżącego rozmiaru rozszerzenia.

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

Parametry

Usuwa obiekt, który to rozszerzenie uwidoczniło w ramce hosta.

function unregister(instanceId: string)

Parametry

Numer wersji Web SDK. Można to określić w zestawie wymagań rozszerzenia, takich jak: vss-sdk-version/4.2

sdkVersion: 5

Typ