Interface IMetadataSource

Interface implemented by update metadata sources. Metadata sources retrieve raw metadata to be ingested into the package graph object model and subsequently stored locally and queries.

Namespace: Microsoft.PackageGraph.Storage
Assembly: package-graph-microsoft-update.dll
Syntax
public interface IMetadataSource

Methods

| Improve this Doc View Source

ContainsMetadata(IPackageIdentity)

Checks if the source has metadata for a specific package ID

Declaration
bool ContainsMetadata(IPackageIdentity packageIdentity)
Parameters
Type Name Description
IPackageIdentity packageIdentity

Package identity
Returns
Type Description
System.Boolean

True if the source has raw metadata
| Improve this Doc View Source

CopyTo(IMetadataSink, IMetadataFilter, CancellationToken)

Copies select package metadata from this source to the target metadata sink

Declaration
void CopyTo(IMetadataSink destination, IMetadataFilter filter, CancellationToken cancelToken)
Parameters
Type Name Description
IMetadataSink destination

Metadata destination
IMetadataFilter filter

Filter to apply during copy
System.Threading.CancellationToken cancelToken

Cancellation token
| Improve this Doc View Source

CopyTo(IMetadataSink, CancellationToken)

Copies all package metadata from this source to the target metadata sink

Declaration
void CopyTo(IMetadataSink destination, CancellationToken cancelToken)
Parameters
Type Name Description
IMetadataSink destination

Metadata destination
System.Threading.CancellationToken cancelToken

Cancellation token
| Improve this Doc View Source

GetFiles<T>(IPackageIdentity)

Retrieves content files associated with a package

Declaration
List<T> GetFiles<T>(IPackageIdentity packageIdentity)
Parameters
Type Name Description
IPackageIdentity packageIdentity

The identity of the package
Returns
Type Description
System.Collections.Generic.List<T>

List of content files associated with the package
Type Parameters
Name Description
T

The type of content file applicable to the package, depending on the partition
| Improve this Doc View Source

GetMetadata(IPackageIdentity)

Get raw metadata for a package identity

Declaration
Stream GetMetadata(IPackageIdentity packageIdentity)
Parameters
Type Name Description
IPackageIdentity packageIdentity

Package identity
Returns
Type Description
System.IO.Stream

Package raw metadata.

Events

| Improve this Doc View Source

MetadataCopyProgress

Progress notification during metadata copy operations

Declaration
event EventHandler<PackageStoreEventArgs> MetadataCopyProgress
Event Type
Type Description
System.EventHandler<PackageStoreEventArgs>
| Improve this Doc View Source

OpenProgress

Progress notifications during opening the metadata source

Declaration
event EventHandler<PackageStoreEventArgs> OpenProgress
Event Type
Type Description
System.EventHandler<PackageStoreEventArgs>