interface IExtensionManagementApi {
    baseUrl: string;
    http: HttpClient;
    rest: RestClient;
    userAgent: string;
    vsoClient: VsoClient;
    createAcceptHeader(type: string, apiVersion?: string): string;
    createDocumentByName(
        doc: any,
        publisherName: string,
        extensionName: string,
        scopeType: string,
        scopeValue: string,
        collectionName: string,
    ): Promise<any>;
    createRequestOptions(type: string, apiVersion?: string): IRequestOptions;
    deleteDocumentByName(
        publisherName: string,
        extensionName: string,
        scopeType: string,
        scopeValue: string,
        collectionName: string,
        documentId: string,
    ): Promise<void>;
    deleteRequest(publisherName: string, extensionName: string): Promise<void>;
    formatResponse(
        data: any,
        responseTypeMetadata: any,
        isCollection: boolean,
    ): any;
    getAcquisitionOptions(
        itemId: string,
        testCommerce?: boolean,
        isFreeOrTrialInstall?: boolean,
        isAccountOwner?: boolean,
        isLinked?: boolean,
        isConnectedServer?: boolean,
        isBuyOperationValid?: boolean,
    ): Promise<AcquisitionOptions>;
    getAuditLog(
        publisherName: string,
        extensionName: string,
    ): Promise<ExtensionAuditLog>;
    getDocumentByName(
        publisherName: string,
        extensionName: string,
        scopeType: string,
        scopeValue: string,
        collectionName: string,
        documentId: string,
    ): Promise<any>;
    getDocumentsByName(
        publisherName: string,
        extensionName: string,
        scopeType: string,
        scopeValue: string,
        collectionName: string,
    ): Promise<any[]>;
    getInstalledExtensionByName(
        publisherName: string,
        extensionName: string,
        assetTypes?: string[],
    ): Promise<InstalledExtension>;
    getInstalledExtensions(
        includeDisabledExtensions?: boolean,
        includeErrors?: boolean,
        assetTypes?: string[],
        includeInstallationIssues?: boolean,
    ): Promise<InstalledExtension[]>;
    getPolicies(userId: string): Promise<UserExtensionPolicy>;
    getRequests(): Promise<RequestedExtension[]>;
    getStates(
        includeDisabled?: boolean,
        includeErrors?: boolean,
        includeInstallationIssues?: boolean,
        forceRefresh?: boolean,
    ): Promise<ExtensionState[]>;
    getToken(): Promise<string>;
    installExtensionByName(
        publisherName: string,
        extensionName: string,
        version?: string,
    ): Promise<InstalledExtension>;
    queryCollectionsByName(
        collectionQuery: ExtensionDataCollectionQuery,
        publisherName: string,
        extensionName: string,
    ): Promise<ExtensionDataCollection[]>;
    queryExtensions(
        query: InstalledExtensionQuery,
    ): Promise<InstalledExtension[]>;
    registerAuthorization(
        publisherName: string,
        extensionName: string,
        registrationId: string,
    ): Promise<ExtensionAuthorization>;
    requestAcquisition(
        acquisitionRequest: ExtensionAcquisitionRequest,
    ): Promise<ExtensionAcquisitionRequest>;
    requestExtension(
        publisherName: string,
        extensionName: string,
        requestMessage: string,
    ): Promise<RequestedExtension>;
    resolveAllRequests(
        rejectMessage: string,
        publisherName: string,
        extensionName: string,
        state: ExtensionRequestState,
    ): Promise<number>;
    resolveRequest(
        rejectMessage: string,
        publisherName: string,
        extensionName: string,
        requesterId: string,
        state: ExtensionRequestState,
    ): Promise<number>;
    setDocumentByName(
        doc: any,
        publisherName: string,
        extensionName: string,
        scopeType: string,
        scopeValue: string,
        collectionName: string,
    ): Promise<any>;
    uninstallExtensionByName(
        publisherName: string,
        extensionName: string,
        reason?: string,
        reasonCode?: string,
    ): Promise<void>;
    updateDocumentByName(
        doc: any,
        publisherName: string,
        extensionName: string,
        scopeType: string,
        scopeValue: string,
        collectionName: string,
    ): Promise<any>;
    updateInstalledExtension(
        extension: InstalledExtension,
    ): Promise<InstalledExtension>;
}

Hierarchy (View Summary)

Implemented by

Properties

baseUrl: string
http: HttpClient
rest: RestClient
userAgent: string
vsoClient: VsoClient

Methods

  • Parameters

    • doc: any
    • publisherName: string
    • extensionName: string
    • scopeType: string
    • scopeValue: string
    • collectionName: string

    Returns Promise<any>

  • Parameters

    • publisherName: string
    • extensionName: string
    • scopeType: string
    • scopeValue: string
    • collectionName: string
    • documentId: string

    Returns Promise<void>

  • Parameters

    • itemId: string
    • OptionaltestCommerce: boolean
    • OptionalisFreeOrTrialInstall: boolean
    • OptionalisAccountOwner: boolean
    • OptionalisLinked: boolean
    • OptionalisConnectedServer: boolean
    • OptionalisBuyOperationValid: boolean

    Returns Promise<AcquisitionOptions>

  • Parameters

    • publisherName: string
    • extensionName: string
    • scopeType: string
    • scopeValue: string
    • collectionName: string
    • documentId: string

    Returns Promise<any>

  • Parameters

    • publisherName: string
    • extensionName: string
    • scopeType: string
    • scopeValue: string
    • collectionName: string

    Returns Promise<any[]>

  • Parameters

    • doc: any
    • publisherName: string
    • extensionName: string
    • scopeType: string
    • scopeValue: string
    • collectionName: string

    Returns Promise<any>

  • Parameters

    • publisherName: string
    • extensionName: string
    • Optionalreason: string
    • OptionalreasonCode: string

    Returns Promise<void>

  • Parameters

    • doc: any
    • publisherName: string
    • extensionName: string
    • scopeType: string
    • scopeValue: string
    • collectionName: string

    Returns Promise<any>