Class MTConnectorProfile

Namespace: Datamine.MineTrustConnector.Core

Assembly: Datamine.MineTrustConnector.Core.dll

Profile which describes the operational profile for a local user of MineTrust Connector

[JsonObject(ItemNullValueHandling = NullValueHandling.Ignore)]
public class MTConnectorProfile

Inheritance: object

MTConnectorProfile

Inherited Members: object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Properties

ConfigSchemasRoot

Gets or sets the config schemas folder. This is the location in which the schema helper expects to the config schema hierarchy

public required string ConfigSchemasRoot { get; set; }

Property Value

string: The configuration schemas root.

PackageConfigurationsFolder

Gets or sets the package configurations folder. This is the location in which MT Connector expects to find the package configuration

public required string PackageConfigurationsFolder { get; set; }

Property Value

string: The package configurations folder.

PackageLockFilesFolder

Gets or sets the package lock files folder. This is the location in which MT Connector stores information about which packages are locked locally

public required string PackageLockFilesFolder { get; set; }

Property Value

string: The package lock files folder.

TempPackagesFolder

Gets or sets the temporary packages folder. This is the location to which packages may be temporarily synced in order to obtain files on a one-off basis

public required string TempPackagesFolder { get; set; }

Property Value

string: The temporary packages folder.

UserID

Gets or sets the unique identifier for the corresponding user. On Windows systems, returns the security identifier (SID) of the user. On non-Windows systems, is just the user name.

public required string UserID { get; set; }

Property Value

string: The user identifier.

Methods

EnsureCurrentUserProfile()

Gets the MTConnectorProfile for the current user - creating it if necessary.

public static MTConnectorProfile EnsureCurrentUserProfile()

Returns

MTConnectorProfile

GetLocalTagCacheLocation(string?)

Gets or the formatted path on disk to the file which backs the embedded tag cache database for the specified service UID.

public string GetLocalTagCacheLocation(string? serviceUID)

Parameters

serviceUID string: The service uid.

Returns

string: The tag cache location

Purge()

Purges all local app data corresponding to this user's profile. Invoke with caution - since doing so will permanently delete all of the following:

Package configurations
Configuration data
Package lock data
All tag caches

public void Purge()