MineTrustConnector::CppCliInterop::PackageConfiguration Struct Reference

#include <CppCliInterop.h>

Public Attributes
std::string	filePath
bool	enabled = false
std::string	displayName
std::string	packageUID
std::string	serverUrl
std::string	localRoot
std::string	mineTrustRoot
std::vector< std::string >	tagNamingPatterns
std::vector< IncludeConfiguration >	include
std::vector< std::string >	exclude
int	targetVersion = 0
bool	exclusiveCheckOut = false
std::string	owner
std::string	visibility
std::string	filter

Static Public Attributes
static MT_CONNECTOR_EXPORT const std::string	SHARED_PACKAGE_VISIBILITY = "Shared"
static MT_CONNECTOR_EXPORT const std::string	PRIVATE_PACKAGE_VISIBILITY = "Private"

Detailed Description

Class defining a package configuration. Instances of this class are serializable to/from JSON

Initializes a new instance of the PackageConfiguration class.

Examples

NativeApp.cpp.

Member Data Documentation

displayName

std::string MineTrustConnector::CppCliInterop::PackageConfiguration::displayName

Gets or sets the display name to use for this package

Examples

NativeApp.cpp.

enabled

bool MineTrustConnector::CppCliInterop::PackageConfiguration::enabled = false

Gets or sets a value indicating whether this PackageConfiguration is enabled. If set to false, then MT Connector will not process this package configuration.

Examples

NativeApp.cpp.

exclude

std::vector<std::string> MineTrustConnector::CppCliInterop::PackageConfiguration::exclude

Gets or sets a list of file names which should be excluded from this package (those which would otherwise be included under the normal rules of package composition)

exclusiveCheckOut

bool MineTrustConnector::CppCliInterop::PackageConfiguration::exclusiveCheckOut = false

If a 'TargetVersion' has been specified, determines whether or not to exclusively check out those files from MineTrust Server.

filePath

std::string MineTrustConnector::CppCliInterop::PackageConfiguration::filePath

Gets the file path where this configuration is stored.

filter

std::string MineTrustConnector::CppCliInterop::PackageConfiguration::filter

Gets or sets a filter string which resolves the subset of this package whose contents should be synchronised.

include

std::vector<IncludeConfiguration> MineTrustConnector::CppCliInterop::PackageConfiguration::include

Gets or sets the prescribed set of files which make up this package. By default, packages are composed of everything within 'LocalRoot' unless this value is specified.

localRoot

std::string MineTrustConnector::CppCliInterop::PackageConfiguration::localRoot

Gets or sets the local file path from which relative paths within this package are based.

Examples

NativeApp.cpp.

mineTrustRoot

std::string MineTrustConnector::CppCliInterop::PackageConfiguration::mineTrustRoot

Gets or sets the root location within MineTrust Server where the package will be stored. If unspecified, defaults to Folders\Managed Folders\Packages\{PackageUID} where {PackageUID} is the ID of the package.

owner

std::string MineTrustConnector::CppCliInterop::PackageConfiguration::owner

String which describes the local 'owner' of this package. If used, will typically be a process ID of the form 'PID={pid}', indicating that the package is in use exclusively by a particular instance of an application.

packageUID

std::string MineTrustConnector::CppCliInterop::PackageConfiguration::packageUID

Gets or sets the unique Package Identifier for this package

Examples

NativeApp.cpp.

PRIVATE_PACKAGE_VISIBILITY

const std::string MineTrustConnector::CppCliInterop::PackageConfiguration::PRIVATE_PACKAGE_VISIBILITY = "Private"

static

The constant string value for 'Private' package visibility

serverUrl

std::string MineTrustConnector::CppCliInterop::PackageConfiguration::serverUrl

Gets or sets the server URL which this Package uses as its Data Source

Examples

NativeApp.cpp.

SHARED_PACKAGE_VISIBILITY

const std::string MineTrustConnector::CppCliInterop::PackageConfiguration::SHARED_PACKAGE_VISIBILITY = "Shared"

static

The constant string value for 'Shared' package visibility

tagNamingPatterns

std::vector<std::string> MineTrustConnector::CppCliInterop::PackageConfiguration::tagNamingPatterns

Gets or sets the file path patterns which may be used to automatically assign tags to items based on their location. Files are always tagged by their PackageUID by default - it is not necessary to specifically prescribe a naming pattern for this

targetVersion

int MineTrustConnector::CppCliInterop::PackageConfiguration::targetVersion = 0

Gets or sets the ID of the version which MT Connector should attempt to replicate to the local working package.

visibility

std::string MineTrustConnector::CppCliInterop::PackageConfiguration::visibility

Gets or sets the visibility of this package. Current supported values are 'Private' and 'Shared' (with default being 'Private'). 'Private' packages are browsable only by their creators, whereas 'Shared' packages can be viewed and edited by all users with the 'Contributor' role assignment.

Examples

NativeApp.cpp.

---

The documentation for this struct was generated from the following files:

• CppCliInterop.h
• CppCliInterop.cpp