Table of Contents

Class Product

Namespace
StockSharp.Installer
Assembly
StockSharp.Installer.dll

Product.

public class Product : BaseLogReceiver, IPersistable, ILogReceiver, ILogSource, IDisposable
Inheritance
Product
Implements
IPersistable
Inherited Members
Extension Methods

Properties

Author

Product author.

public long? Author { get; }

Property Value

long?

AvailableUpdate

Available update or null if not available.

public ProductUpdate? AvailableUpdate { get; }

Property Value

ProductUpdate?

AvailableVersion

Product available version.

public ProductVersion AvailableVersion { get; }

Property Value

ProductVersion

CanBuy 

public bool CanBuy { get; }

Property Value

bool

CanInstall 

public bool CanInstall { get; }

Property Value

bool

CanModify 

public bool CanModify { get; }

Property Value

bool

CanRate

Whether this user can rate this product.

public bool CanRate { get; }

Property Value

bool

CanRemove 

public bool CanRemove { get; }

Property Value

bool

CanRepair 

public bool CanRepair { get; }

Property Value

bool

CanRequestRefund 

public bool CanRequestRefund { get; }

Property Value

bool

CanRequestTrial 

public bool CanRequestTrial { get; }

Property Value

bool

CanUpdate 

public bool CanUpdate { get; }

Property Value

bool

ContentType

Product content type.

public ProductContentTypes2? ContentType { get; }

Property Value

ProductContentTypes2?

Description

Product description.

public string Description { get; }

Property Value

string

DocUrl

Document url.

public string DocUrl { get; }

Property Value

string

DownloadCount

Download count.

public int? DownloadCount { get; }

Property Value

int?

Feedbacks

Product feedback messages.

public ProductFeedback[] Feedbacks { get; }

Property Value

ProductFeedback[]

InstallContentFiles

Whether installer need to install content files from main package.

public bool InstallContentFiles { get; }

Property Value

bool

InstallFramework

Product install framework.

public NuGetFramework InstallFramework { get; }

Property Value

NuGetFramework

Installation

Existing product installation.

public ProductInstallation Installation { get; }

Property Value

ProductInstallation

IsActiveSubscription 

public bool IsActiveSubscription { get; }

Property Value

bool

IsConnector

Whether this product is connector.

public bool IsConnector { get; }

Property Value

bool

IsDesigner 

public bool IsDesigner { get; }

Property Value

bool

IsDesignerSchema 

public bool IsDesignerSchema { get; }

Property Value

bool

IsExpiredSubscription 

public bool IsExpiredSubscription { get; }

Property Value

bool

IsFreeProduct 

public bool IsFreeProduct { get; }

Property Value

bool

IsIndependentProduct

Wheter this product is independent product (not a plugin or connector).

public bool IsIndependentProduct { get; }

Property Value

bool

IsInstalled 

public bool IsInstalled { get; }

Property Value

bool

IsInstaller 

public bool IsInstaller { get; }

Property Value

bool

IsMyProduct

Whether current user is the owner of this product.

public bool IsMyProduct { get; }

Property Value

bool

IsPackageAvailable

Whether package is available in nuget.

public bool IsPackageAvailable { get; }

Property Value

bool

IsPaidProduct 

public bool IsPaidProduct { get; }

Property Value

bool

IsPurchasedConnector 

public bool IsPurchasedConnector { get; }

Property Value

bool

IsRefundRequested 

public bool IsRefundRequested { get; }

Property Value

bool

IsRequiredConnectors

Whether this product requires connectors.

public bool IsRequiredConnectors { get; }

Property Value

bool

IsSourceCode

Whether this product is source code.

public bool IsSourceCode { get; }

Property Value

bool

IsStandaloneApp

Whether this product is a standalone application.

public bool IsStandaloneApp { get; }

Property Value

bool

IsTrialRequested 

public bool IsTrialRequested { get; }

Property Value

bool

IsUpdateAvailable 

public bool IsUpdateAvailable { get; }

Property Value

bool

IsVersionAvailable

True if both package available and product version is in db.

public bool IsVersionAvailable { get; }

Property Value

bool

MainPackageId

Product id (nuget package id).

public string MainPackageId { get; }

Property Value

string

PluginType

Plugin type or null.

public Product.PluginTypes? PluginType { get; }

Property Value

Product.PluginTypes?

ProductDomain

Product domain info.

public ProductDomain ProductDomain { get; }

Property Value

ProductDomain

ProductKey

Product unique id.

public long ProductKey { get; }

Property Value

long

ProductName

Product name.

public string ProductName { get; }

Property Value

string

Rating

Rating.

public double? Rating { get; }

Property Value

double?

SortOrder

Sort order.

public int SortOrder { get; }

Property Value

int

Tags

Product tags.

public string Tags { get; }

Property Value

string

Topic

Description.

public Topic Topic { get; }

Property Value

Topic

WasPurchased 

public bool WasPurchased { get; }

Property Value

bool

WasRated

Whether the product was rated by this user.

public bool? WasRated { get; }

Property Value

bool?

WebProduct

Product description message from db.

public Product WebProduct { get; }

Property Value

Product

Methods

CanInstallInNonEmptyFolder() 

public bool CanInstallInNonEmptyFolder()

Returns

bool

EnsureProductDetailsAsync(bool, CancellationToken)

Load product info for details page.

public Task EnsureProductDetailsAsync(bool forceUpdate, CancellationToken token)

Parameters

forceUpdate bool
token CancellationToken

Returns

Task

Exceptions

InvalidOperationException

GetInstallSubdirectory(string) 

public string GetInstallSubdirectory(string filePathInPackage)

Parameters

filePathInPackage string

Returns

string

GetPluginParentAppName(PluginTypes?)

Get app name for plugin type.

public static string GetPluginParentAppName(Product.PluginTypes? type)

Parameters

type Product.PluginTypes?

Returns

string

Exceptions

ArgumentOutOfRangeException

HasAddIn(string)

Whether this product has adding with specified id.

public bool HasAddIn(string addInId)

Parameters

addInId string

Returns

bool

InstallAsync(ProductVersion, string, CancellationToken)

Install product.

public Task InstallAsync(ProductVersion version, string dir, CancellationToken token)

Parameters

version ProductVersion
dir string
token CancellationToken

Returns

Task

Exceptions

InvalidOperationException

Load(SettingsStorage)

Load settings.

public override void Load(SettingsStorage storage)

Parameters

storage SettingsStorage

Settings storage.

RemoveAsync(CancellationToken)

Remove product.

public Task RemoveAsync(CancellationToken token)

Parameters

token CancellationToken

Returns

Task

Exceptions

InvalidOperationException

RepairAsync(ProductVersion, CancellationToken)

Repair product.

public Task RepairAsync(ProductVersion version, CancellationToken token)

Parameters

version ProductVersion
token CancellationToken

Returns

Task

Exceptions

InvalidOperationException

RequestRefund(CancellationToken) 

public Task RequestRefund(CancellationToken token)

Parameters

token CancellationToken

Returns

Task

RequestTrial(CancellationToken) 

public Task RequestTrial(CancellationToken token)

Parameters

token CancellationToken

Returns

Task

Save(SettingsStorage)

Save settings.

public override void Save(SettingsStorage storage)

Parameters

storage SettingsStorage

Settings storage.

UpdateAsync(ProductVersion, bool, CancellationToken)

Update product.

public Task UpdateAsync(ProductVersion version, bool backupAppSettings, CancellationToken token)

Parameters

version ProductVersion
backupAppSettings bool
token CancellationToken

Returns

Task

Exceptions

InvalidOperationException

Events

InstalledVersionChanged

Invoked when installed version has changed.

public event Action InstalledVersionChanged

Event Type

Action

Refresh

Invoked when the product was updated.

public event Action Refresh

Event Type

Action