Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ArtifactDetailsApi

Hierarchy

  • ArtifactDetailsApi

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Protected basePath

basePath: string = "https://dev.azure.com/"

defaultHeaders

defaultHeaders: any

Methods

getBadge

  • getBadge(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<string>

  • Generate a SVG badge for the latest version of a package. The generated SVG is typically used as the image in an HTML link which takes users to the feed containing the package to accelerate discovery and consumption.

    Parameters

    • params: object
      • apiVersion: string
      • feedId: string
      • organization: string
      • packageId: string
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<string>

getPackage

  • getPackage(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<ModelPackage>

  • Get details about a specific package.

    Parameters

    • params: object
      • apiVersion: string
      • feedId: string
      • Optional includeAllVersions?: boolean
      • Optional includeDeleted?: boolean
      • Optional includeDescription?: boolean
      • Optional includeUrls?: boolean
      • Optional isListed?: boolean
      • Optional isRelease?: boolean
      • organization: string
      • packageId: string
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<ModelPackage>

getPackageVersion

  • getPackageVersion(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<PackageVersion>

  • Get details about a specific package version.

    Parameters

    • params: object
      • apiVersion: string
      • feedId: string
      • Optional includeUrls?: boolean
      • Optional isDeleted?: boolean
      • Optional isListed?: boolean
      • organization: string
      • packageId: string
      • packageVersionId: string
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<PackageVersion>

getPackageVersionProvenance

  • getPackageVersionProvenance(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<PackageVersionProvenance>

  • Gets provenance for a package version.

    Parameters

    • params: object
      • apiVersion: string
      • feedId: string
      • organization: string
      • packageId: string
      • packageVersionId: string
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<PackageVersionProvenance>

getPackageVersions

  • Get a list of package versions, optionally filtering by state.

    Parameters

    • params: object
      • apiVersion: string
      • feedId: string
      • Optional includeUrls?: boolean
      • Optional isDeleted?: boolean
      • Optional isListed?: boolean
      • organization: string
      • packageId: string
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<ArrayWrapper<PackageVersion>>

getPackages

  • Get details about all of the packages in the feed. Use the various filters to include or exclude information from the result set.

    Parameters

    • params: object
      • Optional $Skip?: number
      • Optional $Top?: number
      • apiVersion: string
      • Optional directUpstreamId?: string
      • feedId: string
      • Optional getTopPackageVersions?: boolean
      • Optional includeAllVersions?: boolean
      • Optional includeDeleted?: boolean
      • Optional includeDescription?: boolean
      • Optional includeUrls?: boolean
      • Optional isCached?: boolean
      • Optional isListed?: boolean
      • Optional isRelease?: boolean
      • Optional normalizedPackageName?: string
      • organization: string
      • Optional packageNameQuery?: string
      • Optional protocolType?: string
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<ArrayWrapper<ModelPackage>>

queryPackageMetrics

queryPackageVersionMetrics

Generated using TypeDoc