• API Documentation
Show / Hide Table of Contents
  • BuildSystem.Allure.Generator
    • AllureServe
  • BuildSystem.Builder.Dotnet
    • BuilderDotnet
    • BuilderDotnetProps
  • BuildSystem.Builder.Midl
    • BuilderMidl
    • BuilderMidlProps
  • BuildSystem.Builder.MsCpp
    • BuilderMsCpp
    • BuilderMsCppProps
  • BuildSystem.Builder.MsDelphi
    • BuilderMsDelphi
    • BuilderMsDelphiProps
  • BuildSystem.BuildSpace
    • IBuildSpace
  • BuildSystem.BuildSpace.Common
    • BuildSpaceCommon
    • RegisterFactoryAssemblies
  • BuildSystem.Cleaner.Common
    • CleanerCommon
    • CleanerCommonProps
  • BuildSystem.Factories
    • BuilderProps
    • CleanerProps
    • Factory<T1, T2>
    • FileCopierProps
    • GenDocProps
    • GenLangProps
    • GitExploreOptions
    • GlobalFactory
    • HashGeneratorProps
    • ITestRunnerProps
    • PackageManagerProps
    • ProjectCacheProps
    • ReclaimerProps
    • ReclaimerStrategyFactory
    • SignerProps
    • TestRunnerProps
    • TlbGenBplProps
    • TlbGenDotnetDllProps
    • TlbGenPasProps
    • VersionManagerProps
  • BuildSystem.FileCopier.Common
    • FileCopierCommon
    • FileCopierCommonProps
  • BuildSystem.GenDoc.DocFX
    • CppReader
    • CSharpConverter
    • DelphiReader
    • GenDocFX
    • GenDocFXProps
    • IReader
    • SourceInfo
    • SourceInfoLang
    • SourceInfoSummary
    • SourceInfoSyntax
    • SourceInfoSyntaxParam
    • SourceInfoType
    • YamlWriter
  • BuildSystem.HashGenerator.Common
    • HashGeneratorCommon
    • HashGeneratorCommonProps
  • BuildSystem.Info
    • BuildInfo
    • JenkinsInfo
    • RunInfo
    • SessionInfo
  • BuildSystem.Loggers
    • LoggerBroadCaster
    • LoggerBuffer
    • LoggerConsole
    • LoggerFile
  • BuildSystem.Logging
    • ILogger
    • LogLevel
    • tagLogLevel
  • BuildSystem.ManagerObject
    • IDictionaryStringString
    • IManager
    • IManagerProp
    • ManagerType
    • tagManagerType
  • BuildSystem.ManagerObject.Interfaces
    • CacheDependencyInfo
    • CacheProjectInfo
    • FileGroup
    • GenLangResult
    • GetPackageInfo
    • GetVersionList
    • HashAlgorithmType
    • IBuilder
    • IBuilderProps
    • ICleaner
    • ICleanerProps
    • IFileCopier
    • IFileCopierProps
    • IGenDoc
    • IGenDocProps
    • IGenLang
    • IGenLangProps
    • IHashGenerator
    • IHashGeneratorProps
    • IPackageManager
    • IPackageManagerProps
    • IProjectCache
    • IProjectCacheProps
    • IReclaimer
    • IReclaimerProps
    • IReclaimerStrategy
    • IReclaimerStrategyProps
    • IRestorer
    • IRestorerProps
    • ISigner
    • ISignerProps
    • ITestRunner
    • ITlbGenBpl
    • ITlbGenBplProps
    • ITlbGenDotnetDll
    • ITlbGenDotnetDllProps
    • ITlbGenPas
    • ITlbGenPasProps
    • IVersionManager
    • IVersionManagerProps
    • ReaderType
    • RestorerDepProp
    • VersionIncrementType
    • VersionIncrementValue
    • VersionManagerType
  • BuildSystem.ManagersFactory
    • IManagersFactory
    • ListManagerNameForVariant
    • ManagerConstNames
    • ManagerNameForVariant
  • BuildSystem.ManagersFactory.Common
    • ManagersFactoryCommon
  • BuildSystem.Nuget.Logging
    • NuGetLogging
  • BuildSystem.Package
    • CachePackageInfo
    • GetNextVersion
    • IPackage
    • IPackageProps
    • LicensePackageInfo
    • PackageAction
    • PackageDependency
    • PackageFiles
    • PackageProps
    • RepoPackageInfo
    • SetDuplicatePushStorageInfo
    • SetStorageInfo
    • StorageInfo
    • VersionProp
  • BuildSystem.Package.Dotnet
    • PackageDotnet
    • PackageDotnetProps
  • BuildSystem.Package.Factory
    • PackageFactory
    • PackageType
  • BuildSystem.Package.Nuget
    • PackageNuget
    • PackageNugetProps
  • BuildSystem.PackageManager.Dotnet
    • PackageManagerDotnet
    • PackageManagerDotnetProps
  • BuildSystem.PackageManager.Nuget
    • PackageManagerNuget
    • PackageManagerNugetProps
  • BuildSystem.Project
    • GetProjectInfoDelegate
    • IProject
    • ProjectGenDocProps
    • ProjectInfo
  • BuildSystem.Project.Base
    • ProjectBase
  • BuildSystem.Project.Cpp
    • ProjectCpp
  • BuildSystem.Project.CSharp
    • ProjectCSharp
  • BuildSystem.Project.Delphi
    • ProjectDelphi
  • BuildSystem.Project.Dependency
    • JsonProjectDependencies
    • NativeDependencies
    • ProjectDependency
  • BuildSystem.Project.Factory
    • ProjectFactory
  • BuildSystem.Project.Idl
    • ProjectIdl
  • BuildSystem.Project.PropReader
    • IProjectPropReader
  • BuildSystem.Project.PropReader.Json
    • ProjectPropReaderJson
  • BuildSystem.Project.Res
    • ProjectRes
  • BuildSystem.Project.Wix
    • ProjectWix
  • BuildSystem.ProjectCache.Common
    • ProjectCacheCommon
    • ProjectCacheCommonProps
  • BuildSystem.ProjectCache.NuGet
    • ProjectCacheNuGet
    • ProjectCacheNuGetProps
  • BuildSystem.ProjectList
    • BuildResultIsRequiredDelegate
    • CalcCopyBuildResultPathDelegate
    • CompilerConstants
    • IAnalyzer
    • IAnalyzerProps
    • IBuildInfoSaver
    • IBuildInfoSaverProps
    • ICompiler
    • ICompilerProps
    • ICopierBuildResults
    • ICopierBuildResultsProps
    • IDeployer
    • IDeployerProps
    • IProjectList
    • IProjectListProps
    • IProjectRestorer
    • IProjectRestorerProps
    • ISourceHashCalculator
    • ISourceHashCalculatorProps
    • ProjectFilter
    • RestoreInsteadOfBuildDelegate
    • SourceHashCalculatorConstants
  • BuildSystem.ProjectList.Common
    • GitHelper
    • GraphDot
    • ManagerRestorer
    • ProjectListCommon
    • ProjectListCommonProps
  • BuildSystem.ProjectList.Factory
    • ProjectListFactory
  • BuildSystem.ProjectList.Helpers
    • AnalyzerCommon
    • AnalyzerCommonProps
    • BuildInfoSaverCommon
    • BuildInfoSaverCommonProps
    • CompilerCommon
    • CompilerCommonProps
    • CopierBuildResultsCommon
    • CopierBuildResultsCommonProps
    • DeployerCommon
    • DeployerCommonProps
    • PackagesRestorer
    • ProjectRestorerCommon
    • ProjectRestorerCommonProps
    • SourceHashCalculatorCommon
    • SourceHashCalculatorCommonProps
    • TransitiveDependenciesBuilder
  • BuildSystem.Reclaimer.NugetCommon
    • ReclaimerNugetCommon
    • ReclaimerNugetCommonProps
  • BuildSystem.Reclaimer.Strategy.Common
    • ReclaimerStrategyCommon
    • ReclaimerStrategyCommonProps
  • BuildSystem.Reclaimer.Strategy.Delegate
    • CalcDeletingPackages
    • ReclaimerStrategyDelegate
    • ReclaimerStrategyDelegateProps
  • BuildSystem.Restorer
    • RestorerProps
  • BuildSystem.Restorer.Nuget
    • RestorerNuget
    • RestorerNugetProps
  • BuildSystem.SettingsReader
    • ISettingsReader
    • ReaderJson
    • SettingsReaderType
  • BuildSystem.SettingsReader.Factory
    • SettingsReaderFactory
  • BuildSystem.SettingsReader.Json
    • SettingsReaderJson
  • BuildSystem.SettingsReader.Object
    • SettingsObject
    • SettingsReaderObject
  • BuildSystem.SharedMemIPC
    • DelayedProcedure
    • HandleRequestProc
    • HandleStreamProc
    • IPCStream
    • SharedMemClient
    • SharedMemObject
    • SharedMemServer
  • BuildSystem.Signer.Win
    • SignerWin
    • SignerWinProps
  • BuildSystem.TestRunner.Common
    • TestRunnerCommon
    • TestRunnerCommonProps
  • BuildSystem.TlbDoc
    • TlbHelpReader
  • BuildSystem.TlbGenBpl.ThroughPas
    • TlbGenBplThroughPas
    • TlbGenBplThroughPasProps
  • BuildSystem.TlbGenDotnetDll.TlbImp
    • TlbGenDotnetDllTlbImp
    • TlbGenDotnetDllTlbImpProps
  • BuildSystem.TlbGenPas.LibImp
    • TlbGenPasLibImp
    • TlbGenPasLibImpProps
  • BuildSystem.TypesCS.Dictionary
    • DictionaryStringString
  • BuildSystem.Utils
    • Matcher
    • PropReader
  • BuildSystem.Utils.AdminRunner
    • AdminRunner
    • SingleRunner
  • BuildSystem.Utils.DirectoryHelper
    • DirectoryCleaner
    • DirectoryCopier
    • DirectoryScanner
  • BuildSystem.Utils.Executor
    • CmdRunner
    • ExeLine
    • ExeRunner
  • BuildSystem.Utils.FileFormatter
    • FileFormatter
  • BuildSystem.Utils.GitHelper
    • GitRepository
  • BuildSystem.Utils.IpcProcessRunner
    • ProcessRunner
  • BuildSystem.Utils.Json
    • JsonDefinesFormatter
    • JsonReader
    • JsonUtils
  • BuildSystem.Utils.PathReader
    • PathReader
  • BuildSystem.Utils.Xml
    • XmlUtils
  • BuildSystem.Variants
    • ConfigurationType
    • TargetPlatform
    • Variant
    • VariantList
  • BuildSystem.VersionManager.Common
    • VersionManagerCommon
    • VersionManagerCommonProps
  • IdeProjectFileEditor
    • DBinOutType
    • DConfigType
    • DotNetOutPathType
    • DotNetReferenceType
    • DPathPropType
    • DPlatformType
    • IDelphiMainSrcEditor
    • IDelphiProjectEditor
    • IDEProjectEditor
    • IDotNetProjectEditor
    • IProjectReferenceEditor
    • IXMLEditor
    • ProjectReferenceInfo
  • ProjectDependencyScanner
    • DependencyScanner
    • IDLAdditionalInfo
    • IDotNetAdditionalInfo
    • IDSProject
    • IDSProjectsList
    • IPDelphiAdditionalInfo
    • IProjectDependencyScanner
    • IProjectsDependenciesScanner
    • PlatformType
    • ProjectType

Interface IPackageProps

Interface for properties of IPackage

Namespace: BuildSystem.Package
Assembly: BuildSystem.ManagerObject.Interfaces.dll
Syntax
public interface IPackageProps : ICloneable

Properties

Authors

List of authors of package

Declaration
List<string> Authors { get; }
Property Value
Type Description
System.Collections.Generic.List<><string>

CacheInfo

Some information stored in cache

Declaration
CachePackageInfo CacheInfo { get; set; }
Property Value
Type Description
CachePackageInfo

Constants

String constants to replace when reading values of properties. For a example $project:title$ = "test.project"

Declaration
Dictionary<string, string> Constants { get; set; }
Property Value
Type Description
System.Collections.Generic.Dictionary<,><string, string>

Copyright

Value of copyright

Declaration
string Copyright { get; }
Property Value
Type Description
string

Description

Description of package

Declaration
string Description { get; }
Property Value
Type Description
string

ExpressionAuthors

List of authors of package

Declaration
List<string> ExpressionAuthors { get; set; }
Property Value
Type Description
System.Collections.Generic.List<><string>

ExpressionCopyright

Value of copyright

Declaration
string ExpressionCopyright { get; set; }
Property Value
Type Description
string

ExpressionDescription

Description of package

Declaration
string ExpressionDescription { get; set; }
Property Value
Type Description
string

ExpressionGroup

Group of package

Declaration
string ExpressionGroup { get; set; }
Property Value
Type Description
string

ExpressionId

Expression that contains id of package - unique name

Declaration
string ExpressionId { get; set; }
Property Value
Type Description
string

ExpressionLanguage

Language of package

Declaration
string ExpressionLanguage { get; set; }
Property Value
Type Description
string

ExpressionOwners

List of owners of package

Declaration
List<string> ExpressionOwners { get; set; }
Property Value
Type Description
System.Collections.Generic.List<><string>

ExpressionProjectURL

Value of projectURL

Declaration
string ExpressionProjectURL { get; set; }
Property Value
Type Description
string

ExpressionTitle

Title of package

Declaration
string ExpressionTitle { get; set; }
Property Value
Type Description
string

Group

Group of package

Declaration
string Group { get; }
Property Value
Type Description
string

Hash

Hash value of sources for binaries in package

Declaration
string Hash { get; set; }
Property Value
Type Description
string

Id

Id of package - unique name

Declaration
string Id { get; }
Property Value
Type Description
string

Language

Language of package

Declaration
string Language { get; }
Property Value
Type Description
string

LicenseInfo

Some information about package license

Declaration
LicensePackageInfo LicenseInfo { get; set; }
Property Value
Type Description
LicensePackageInfo

Owners

List of owners of package

Declaration
List<string> Owners { get; }
Property Value
Type Description
System.Collections.Generic.List<><string>

PackageDependencies

List of package dependencies

Declaration
List<PackageDependency> PackageDependencies { get; set; }
Property Value
Type Description
System.Collections.Generic.List<><PackageDependency>

PackagePath

Path to archive, which can be pushed to the repository

Declaration
string? PackagePath { get; set; }
Property Value
Type Description
string

PackageTempDir

Temporary directory for package

Declaration
string PackageTempDir { get; set; }
Property Value
Type Description
string

ProjectURL

Value of projectURL

Declaration
string ProjectURL { get; }
Property Value
Type Description
string

ReleaseNotes

Value of releaseNotes

Declaration
string ReleaseNotes { get; set; }
Property Value
Type Description
string

RepoInfo

Some information about package repository

Declaration
RepoPackageInfo RepoInfo { get; set; }
Property Value
Type Description
RepoPackageInfo

SourceFiles

Files, which should be copied into package

Declaration
List<string> SourceFiles { get; set; }
Property Value
Type Description
System.Collections.Generic.List<><string>

Tags

List of tags provided to package

Declaration
List<string> Tags { get; set; }
Property Value
Type Description
System.Collections.Generic.List<><string>

Title

Title of package

Declaration
string Title { get; }
Property Value
Type Description
string

Version

Version of package

Declaration
VersionProp Version { get; set; }
Property Value
Type Description
VersionProp

Methods

Copy(IPackageProps)

Copies all properties from source object

Declaration
void Copy(IPackageProps source)
Parameters
Type Name Description
IPackageProps source

Object as source for cloning properties

EmptyValues()

Set values of private properties to default

Declaration
void EmptyValues()

GetValue(string)

Read expression and replace according to Constants

Declaration
string GetValue(string expression)
Parameters
Type Name Description
string expression

Original line

Returns
Type Description
string

Line after replacing expressions

GetValueDictionary(Dictionary<string, string>)

Read expression and replace according to Constants

Declaration
Dictionary<string, string> GetValueDictionary(Dictionary<string, string> expressions)
Parameters
Type Name Description
System.Collections.Generic.Dictionary<,><string, string> expressions

Original line

Returns
Type Description
System.Collections.Generic.Dictionary<,><string, string>

Line after replacing expressions

GetValueList(List<string>)

Read expression and replace according to Constants

Declaration
List<string> GetValueList(List<string> expressions)
Parameters
Type Name Description
System.Collections.Generic.List<><string> expressions

Original line

Returns
Type Description
System.Collections.Generic.List<><string>

Line after replacing expressions

Update(JsonNode?, string)

Read properties from json object

Declaration
void Update(JsonNode? jsonInfo, string relativeDir)
Parameters
Type Name Description
System.Text.Json.Nodes.JsonNode jsonInfo

JsonObject with properties

string relativeDir

Directory which should be added to properties containing relative paths

In This Article
Back to top Generated by DocFX