OpenTAP 9.25
API Reference
Public Member Functions | Properties | Events | List of all members
OpenTap.Package.ImageIdentifier Class Reference

Image that specifies a list of PackageSpecifier to install and a list of repositories to get the packages from. More...

Public Member Functions

delegate void ProgressUpdateDelegate (int progressPercent, string message)
 A delegate used by ProgressUpdate More...
 
ImageSpecifier ToSpecifier ()
 An ImageIdentifier is immutable, but can be converted to an ImageSpecifier which is mutable. More...
 
void Deploy (string targetDir, CancellationToken cancellationToken)
 Deploy the ImageIdentifier as a OpenTAP installation. More...
 
void Cache ()
 Download all packages to the PackageCache. This is an optional step that can speed up deploying later.
 

Properties

string Id [get]
 Image ID created by hashing the Packages list
 
ReadOnlyCollection< PackageDefPackages [get]
 Package configuration of the Image
 
ReadOnlyCollection< string > Repositories [get]
 Repositories to retrieve the packages from
 

Events

ProgressUpdateDelegate ProgressUpdate
 Called by the action to indicate how far it has gotten. Will usually be called with a progressPercent of 100 to indicate that it is done.
 

Detailed Description

Image that specifies a list of PackageSpecifier to install and a list of repositories to get the packages from.

Member Function Documentation

◆ Deploy()

void OpenTap.Package.ImageIdentifier.Deploy ( string  targetDir,
CancellationToken  cancellationToken 
)
inline

Deploy the ImageIdentifier as a OpenTAP installation.

Parameters
targetDirDirectory to deploy OpenTap installation. If the directory is already an OpenTAP installation, the installation will be modified to match the image System-Wide packages are not removed
cancellationTokenCancellation token

◆ ProgressUpdateDelegate()

delegate void OpenTap.Package.ImageIdentifier.ProgressUpdateDelegate ( int  progressPercent,
string  message 
)

A delegate used by ProgressUpdate

Parameters
progressPercentIndicates progress from 0 to 100.
message

◆ ToSpecifier()

ImageSpecifier OpenTap.Package.ImageIdentifier.ToSpecifier ( )
inline

An ImageIdentifier is immutable, but can be converted to an ImageSpecifier which is mutable.

Returns
ImageSpecifier

OpenTAP 9.25 API built Tue Aug 6 2024 07:49:25