C# Class PackageManagement.Sdk.Request

Show file Open project: 0install/0install-win Class Usage Examples

Public Methods

Method Description
AddDependency ( string providerName, string packageName, string version, string source, string appliesTo ) : string
AddDirectory ( string elementPath, string directoryName, string location, string root, bool isKey ) : string
AddEntity ( string name, string regid, string role, string thumbprint ) : string
AddEvidence ( System.DateTime date, string deviceId ) : string
AddFile ( string elementPath, string fileName, string location, string root, bool isKey, long size, string version ) : string
AddLink ( Uri referenceUri, string relationship, string mediaType, string ownership, string use, string appliesToMedia, string artifact ) : string
AddMeta ( string elementPath ) : string
AddMetadata ( string elementPath, Uri @namespace, string name, string value ) : string
AddMetadata ( string name, string value ) : string
AddMetadata ( string elementPath, string name, string value ) : string
AddPayload ( ) : string
AddProcess ( string elementPath, string processName, int pid ) : string
AddResource ( string elementPath, string type ) : string
AskPermission ( string permission ) : bool
CompleteProgress ( int activityId, bool isSuccessful ) : bool
Debug ( string messageText ) : bool
Error ( ErrorCategory category, string targetObjectValue, string messageText ) : bool
Error ( string id, string category, string targetObjectValue, string messageText ) : bool
GetMessageString ( string messageText, string defaultText ) : string
GetOptionValue ( string name ) : string
GetOptionValues ( string key ) : IEnumerable

Message ( string messageText ) : bool
Progress ( int activityId, int progressPercentage, string messageText ) : bool
ShouldBootstrapProvider ( string requestor, string providerName, string providerVersion, string providerType, string location, string destination ) : bool
ShouldContinue ( string query, string caption ) : bool
ShouldContinue ( string query, string caption, bool &yesToAll, bool &noToAll ) : bool
ShouldContinueWithUntrustedPackageSource ( string package, string packageSource ) : bool
StartProgress ( int parentActivityId, string messageText ) : int
Verbose ( string messageText ) : bool
Warning ( string messageText ) : bool
Yield ( string[]>.Dictionary dictionary ) : bool

Yield values in a dictionary as key/value pairs. (one pair for each value in each key)

Yield ( string[]>.KeyValuePair pair ) : bool
YieldDynamicOption ( string name, string expectedType, bool isRequired ) : bool

Used by a provider to return the fields for a Metadata Definition The cmdlets can use this to supply tab-completion for metadata to the user.

YieldDynamicOption ( string name, string expectedType, bool isRequired, IEnumerable permittedValues ) : bool
YieldKeyValuePair ( string key, string value ) : bool
YieldPackageSource ( string name, string location, bool isTrusted, bool isRegistered, bool isValidated ) : bool

Used by a provider to return fields for a package source (repository)

YieldSoftwareIdentity ( string fastPath, string name, string version, string versionScheme, string summary, string source, string searchKey, string fullPath, string packageFileName ) : string

Used by a provider to return fields for a SoftwareIdentity.

YieldValue ( string value ) : bool

Private Methods

Method Description
FixMeFormat ( string formatString, object args ) : string
FormatMessageString ( string messageText ) : string
GetMessageStringInternal ( string messageText ) : string

Method Details

AddDependency() public abstract method

public abstract AddDependency ( string providerName, string packageName, string version, string source, string appliesTo ) : string
providerName string
packageName string
version string
source string
appliesTo string
return string

AddDirectory() public abstract method

public abstract AddDirectory ( string elementPath, string directoryName, string location, string root, bool isKey ) : string
elementPath string
directoryName string
location string
root string
isKey bool
return string

AddEntity() public abstract method

public abstract AddEntity ( string name, string regid, string role, string thumbprint ) : string
name string
regid string
role string
thumbprint string
return string

AddEvidence() public abstract method

public abstract AddEvidence ( System.DateTime date, string deviceId ) : string
date System.DateTime
deviceId string
return string

AddFile() public abstract method

public abstract AddFile ( string elementPath, string fileName, string location, string root, bool isKey, long size, string version ) : string
elementPath string
fileName string
location string
root string
isKey bool
size long
version string
return string

AddLink() public abstract method

public abstract AddLink ( Uri referenceUri, string relationship, string mediaType, string ownership, string use, string appliesToMedia, string artifact ) : string
referenceUri System.Uri
relationship string
mediaType string
ownership string
use string
appliesToMedia string
artifact string
return string

AddMeta() public abstract method

public abstract AddMeta ( string elementPath ) : string
elementPath string
return string

AddMetadata() public abstract method

public abstract AddMetadata ( string elementPath, Uri @namespace, string name, string value ) : string
elementPath string
@namespace System.Uri
name string
value string
return string

AddMetadata() public abstract method

public abstract AddMetadata ( string name, string value ) : string
name string
value string
return string

AddMetadata() public abstract method

public abstract AddMetadata ( string elementPath, string name, string value ) : string
elementPath string
name string
value string
return string

AddPayload() public abstract method

public abstract AddPayload ( ) : string
return string

AddProcess() public abstract method

public abstract AddProcess ( string elementPath, string processName, int pid ) : string
elementPath string
processName string
pid int
return string

AddResource() public abstract method

public abstract AddResource ( string elementPath, string type ) : string
elementPath string
type string
return string

AskPermission() public abstract method

public abstract AskPermission ( string permission ) : bool
permission string
return bool

CompleteProgress() public abstract method

public abstract CompleteProgress ( int activityId, bool isSuccessful ) : bool
activityId int
isSuccessful bool
return bool

Debug() public abstract method

public abstract Debug ( string messageText ) : bool
messageText string
return bool

Error() public method

public Error ( ErrorCategory category, string targetObjectValue, string messageText ) : bool
category ErrorCategory
targetObjectValue string
messageText string
return bool

Error() public abstract method

public abstract Error ( string id, string category, string targetObjectValue, string messageText ) : bool
id string
category string
targetObjectValue string
messageText string
return bool

GetMessageString() public abstract method

public abstract GetMessageString ( string messageText, string defaultText ) : string
messageText string
defaultText string
return string

GetOptionValue() public method

public GetOptionValue ( string name ) : string
name string
return string

GetOptionValues() public abstract method

public abstract GetOptionValues ( string key ) : IEnumerable
key string
return IEnumerable

Message() public abstract method

public abstract Message ( string messageText ) : bool
messageText string
return bool

Progress() public abstract method

public abstract Progress ( int activityId, int progressPercentage, string messageText ) : bool
activityId int
progressPercentage int
messageText string
return bool

ShouldBootstrapProvider() public abstract method

public abstract ShouldBootstrapProvider ( string requestor, string providerName, string providerVersion, string providerType, string location, string destination ) : bool
requestor string
providerName string
providerVersion string
providerType string
location string
destination string
return bool

ShouldContinue() public abstract method

public abstract ShouldContinue ( string query, string caption ) : bool
query string
caption string
return bool

ShouldContinue() public abstract method

public abstract ShouldContinue ( string query, string caption, bool &yesToAll, bool &noToAll ) : bool
query string
caption string
yesToAll bool
noToAll bool
return bool

ShouldContinueWithUntrustedPackageSource() public abstract method

public abstract ShouldContinueWithUntrustedPackageSource ( string package, string packageSource ) : bool
package string
packageSource string
return bool

StartProgress() public abstract method

public abstract StartProgress ( int parentActivityId, string messageText ) : int
parentActivityId int
messageText string
return int

Verbose() public abstract method

public abstract Verbose ( string messageText ) : bool
messageText string
return bool

Warning() public abstract method

public abstract Warning ( string messageText ) : bool
messageText string
return bool

Yield() public method

Yield values in a dictionary as key/value pairs. (one pair for each value in each key)
public Yield ( string[]>.Dictionary dictionary ) : bool
dictionary string[]>.Dictionary
return bool

Yield() public method

public Yield ( string[]>.KeyValuePair pair ) : bool
pair string[]>.KeyValuePair
return bool

YieldDynamicOption() public abstract method

Used by a provider to return the fields for a Metadata Definition The cmdlets can use this to supply tab-completion for metadata to the user.
public abstract YieldDynamicOption ( string name, string expectedType, bool isRequired ) : bool
name string the provider-defined name of the option
expectedType string one of ['string','int','path','switch']
isRequired bool if the parameter is mandatory
return bool

YieldDynamicOption() public method

public YieldDynamicOption ( string name, string expectedType, bool isRequired, IEnumerable permittedValues ) : bool
name string
expectedType string
isRequired bool
permittedValues IEnumerable
return bool

YieldKeyValuePair() public abstract method

public abstract YieldKeyValuePair ( string key, string value ) : bool
key string
value string
return bool

YieldPackageSource() public abstract method

Used by a provider to return fields for a package source (repository)
public abstract YieldPackageSource ( string name, string location, bool isTrusted, bool isRegistered, bool isValidated ) : bool
name string
location string
isTrusted bool
isRegistered bool
isValidated bool
return bool

YieldSoftwareIdentity() public abstract method

Used by a provider to return fields for a SoftwareIdentity.
public abstract YieldSoftwareIdentity ( string fastPath, string name, string version, string versionScheme, string summary, string source, string searchKey, string fullPath, string packageFileName ) : string
fastPath string
name string
version string
versionScheme string
summary string
source string
searchKey string
fullPath string
packageFileName string
return string

YieldValue() public abstract method

public abstract YieldValue ( string value ) : bool
value string
return bool