Interface IExtensionManager

Manager for extensions running in CAM Open API

Namespace: CAMAPI.Extensions

Assembly: CAMAPI.Extensions.dll

Syntax

[InterfaceType(ComInterfaceType.InterfaceIsIUnknown)]
[Guid("5F953309-EC6F-4C54-A1BF-6C0B42A57C71")]
public interface IExtensionManager

Properties

ApiDependencies

List of DLLs, which belong to CAMAPI.SDK and can be used to build extensions

Declaration

IListString ApiDependencies { get; }

Property Value

Type	Description
IListString

ApiVersion

Get version CAMAPI.SDK which includes all interfaces

Declaration

string ApiVersion { get; }

Property Value

Type	Description
string

Logger

Logging object

Declaration

IExtensionLogger Logger { get; }

Property Value

Type	Description
IExtensionLogger

Methods

AddExtension(TStorageType, string, string, out TResultStatus)

Declaration

void AddExtension(TStorageType StorageType, string LibraryPath, string ExtensionTypeId, out TResultStatus ret)

Parameters

Type	Name	Description
TStorageType	StorageType
string	LibraryPath
string	ExtensionTypeId
TResultStatus	ret

CreateExtension(string, out TResultStatus)

Declaration

IExtension CreateExtension(string ExtensionTypeId, out TResultStatus ret)

Parameters

Type	Name	Description
string	ExtensionTypeId
TResultStatus	ret

Returns

Type	Description
IExtension

CreateExtensionsByGroups(string, out TResultStatus)

Declaration

IListExtension CreateExtensionsByGroups(string ExtensionGroups, out TResultStatus ret)

Parameters

Type	Name	Description
string	ExtensionGroups
TResultStatus	ret

Returns

Type	Description
IListExtension

FinalizeExtensions(out TResultStatus)

Declaration

void FinalizeExtensions(out TResultStatus ret)

Parameters

Type	Name	Description
TResultStatus	ret

FreeExtension(long, out TResultStatus)

Declaration

void FreeExtension(long ExtensionInstanceId, out TResultStatus ret)

Parameters

Type	Name	Description
long	ExtensionInstanceId
TResultStatus	ret

FreeExtensionsByTypeId(string, out TResultStatus)

Declaration

void FreeExtensionsByTypeId(string ExtensionTypeId, out TResultStatus ret)

Parameters

Type	Name	Description
string	ExtensionTypeId
TResultStatus	ret

FreeLibrary(string, out TResultStatus)

Declaration

void FreeLibrary(string LibraryPath, out TResultStatus ret)

Parameters

Type	Name	Description
string	LibraryPath
TResultStatus	ret

GetExtension(long, out TResultStatus)

Declaration

IExtension GetExtension(long ExtensionInstanceId, out TResultStatus ret)

Parameters

Type	Name	Description
long	ExtensionInstanceId
TResultStatus	ret

Returns

Type	Description
IExtension

GetExtensionDisabled(TStorageType, string, out TResultStatus)

Declaration

bool GetExtensionDisabled(TStorageType StorageType, string ExtensionTypeId, out TResultStatus ret)

Parameters

Type	Name	Description
TStorageType	StorageType
string	ExtensionTypeId
TResultStatus	ret

Returns

Type	Description
bool

GetExtensionDisabledFinal(string, out TResultStatus)

Declaration

bool GetExtensionDisabledFinal(string ExtensionTypeId, out TResultStatus ret)

Parameters

Type	Name	Description
string	ExtensionTypeId
TResultStatus	ret

Returns

Type	Description
bool

GetExtensionSetting(string, string, out bool, out TResultStatus)

Declaration

string GetExtensionSetting(string ExtensionTypeId, string Key, out bool found, out TResultStatus ret)

Parameters

Type	Name	Description
string	ExtensionTypeId
string	Key
bool	found
TResultStatus	ret

Returns

Type	Description
string

GetExtensionSettingKeys(string, out TResultStatus)

Declaration

IListString GetExtensionSettingKeys(string ExtensionTypeId, out TResultStatus ret)

Parameters

Type	Name	Description
string	ExtensionTypeId
TResultStatus	ret

Returns

Type	Description
IListString

GetExtensionSettingSourceLevel(string, string, out bool, out bool, out TResultStatus)

Declaration

TStorageType GetExtensionSettingSourceLevel(string ExtensionTypeId, string Key, out bool found, out bool fromDefault, out TResultStatus ret)

Parameters

Type	Name	Description
string	ExtensionTypeId
string	Key
bool	found
bool	fromDefault
TResultStatus	ret

Returns

Type	Description
TStorageType

GetExtensionTypeGroup(string, out TResultStatus)

Declaration

IExtensionTypeGroup GetExtensionTypeGroup(string ExtensionTypeGroupId, out TResultStatus ret)

Parameters

Type	Name	Description
string	ExtensionTypeGroupId
TResultStatus	ret

Returns

Type	Description
IExtensionTypeGroup

GetExtensionTypeGroups(out TResultStatus)

Declaration

IListString GetExtensionTypeGroups(out TResultStatus ret)

Parameters

Type	Name	Description
TResultStatus	ret

Returns

Type	Description
IListString

GetExtensionTypeInfo(string, out TResultStatus)

Declaration

IExtensionTypeInfo GetExtensionTypeInfo(string ExtensionTypeId, out TResultStatus ret)

Parameters

Type	Name	Description
string	ExtensionTypeId
TResultStatus	ret

Returns

Type	Description
IExtensionTypeInfo

GetExtensionTypeInfos(string, out TResultStatus)

Declaration

IListExtensionTypeInfo GetExtensionTypeInfos(string ExtensionTypeGroup, out TResultStatus ret)

Parameters

Type	Name	Description
string	ExtensionTypeGroup
TResultStatus	ret

Returns

Type	Description
IListExtensionTypeInfo

GetExtensionTypeInfosFromLibrary(string, out TResultStatus)

Declaration

IListExtensionTypeInfo GetExtensionTypeInfosFromLibrary(string LibraryPath, out TResultStatus ret)

Parameters

Type	Name	Description
string	LibraryPath
TResultStatus	ret

Returns

Type	Description
IListExtensionTypeInfo

GetExtensionsByTypeId(string, out TResultStatus)

Declaration

IListExtension GetExtensionsByTypeId(string ExtensionTypeId, out TResultStatus ret)

Parameters

Type	Name	Description
string	ExtensionTypeId
TResultStatus	ret

Returns

Type	Description
IListExtension

GetFieldInherited(TStorageType, string, TStorageField, out TResultStatus)

Declaration

bool GetFieldInherited(TStorageType StorageType, string EntityIdent, TStorageField field, out TResultStatus ret)

Parameters

Type	Name	Description
TStorageType	StorageType
string	EntityIdent
TStorageField	field
TResultStatus	ret

Returns

Type	Description
bool

GetLibrariesInfo()

Get information about all registered libraries

Declaration

IListExtensionLibraryInfo GetLibrariesInfo()

Returns

Type	Description
IListExtensionLibraryInfo

GetLibraryDisabled(TStorageType, string, out TResultStatus)

Declaration

bool GetLibraryDisabled(TStorageType StorageType, string LibraryPath, out TResultStatus ret)

Parameters

Type	Name	Description
TStorageType	StorageType
string	LibraryPath
TResultStatus	ret

Returns

Type	Description
bool

GetLibraryDisabledFinal(string, out TResultStatus)

Declaration

bool GetLibraryDisabledFinal(string LibraryPath, out TResultStatus ret)

Parameters

Type	Name	Description
string	LibraryPath
TResultStatus	ret

Returns

Type	Description
bool

GetLibraryInfo(string, out TResultStatus)

Declaration

IExtensionLibraryInfo GetLibraryInfo(string ExtensionTypeId, out TResultStatus ret)

Parameters

Type	Name	Description
string	ExtensionTypeId
TResultStatus	ret

Returns

Type	Description
IExtensionLibraryInfo

GetLibraryLoaded(string, out TResultStatus)

Declaration

bool GetLibraryLoaded(string LibraryPath, out TResultStatus ret)

Parameters

Type	Name	Description
string	LibraryPath
TResultStatus	ret

Returns

Type	Description
bool

GetLibraryStorages(string, out TResultStatus)

Declaration

IListInteger GetLibraryStorages(string LibraryPath, out TResultStatus ret)

Parameters

Type	Name	Description
string	LibraryPath
TResultStatus	ret

Returns

Type	Description
IListInteger

GetPendingDeletionLibraries()

Get libraries with pending deletion (DLL was locked during UnRegisterLibrary). Returns libraries whose del cleanup artifact still exists on disk. Stale entries (artifact already gone) are removed automatically.

Declaration

IListExtensionLibraryInfo GetPendingDeletionLibraries()

Returns

Type	Description
IListExtensionLibraryInfo

GetSingletonExtension(string, out TResultStatus)

Declaration

IExtension GetSingletonExtension(string ExtensionTypeId, out TResultStatus ret)

Parameters

Type	Name	Description
string	ExtensionTypeId
TResultStatus	ret

Returns

Type	Description
IExtension

RegisterLibrary(TStorageType, string, out TResultStatus)

Declaration

IExtensionLibraryInfo RegisterLibrary(TStorageType StorageType, string JsonFilePath, out TResultStatus ret)

Parameters

Type	Name	Description
TStorageType	StorageType
string	JsonFilePath
TResultStatus	ret

Returns

Type	Description
IExtensionLibraryInfo

RegisterLibraryFromFolder(TStorageType, string, out TResultStatus, out bool)

Declaration

IExtensionLibraryInfo RegisterLibraryFromFolder(TStorageType StorageType, string FolderPath, out TResultStatus ret, out bool needReload)

Parameters

Type	Name	Description
TStorageType	StorageType
string	FolderPath
TResultStatus	ret
bool	needReload

Returns

Type	Description
IExtensionLibraryInfo

ReloadStorage(TStorageType, out TResultStatus)

Declaration

void ReloadStorage(TStorageType StorageType, out TResultStatus ret)

Parameters

Type	Name	Description
TStorageType	StorageType
TResultStatus	ret

RemoveExtension(TStorageType, string, string, out TResultStatus)

Declaration

void RemoveExtension(TStorageType StorageType, string LibraryPath, string ExtensionTypeId, out TResultStatus ret)

Parameters

Type	Name	Description
TStorageType	StorageType
string	LibraryPath
string	ExtensionTypeId
TResultStatus	ret

RemoveExtensionSetting(TStorageType, string, string, out TResultStatus)

Declaration

void RemoveExtensionSetting(TStorageType StorageType, string ExtensionTypeId, string Key, out TResultStatus ret)

Parameters

Type	Name	Description
TStorageType	StorageType
string	ExtensionTypeId
string	Key
TResultStatus	ret

SetExtensionDisabled(TStorageType, string, bool, out TResultStatus)

Declaration

void SetExtensionDisabled(TStorageType StorageType, string ExtensionTypeId, bool Disabled, out TResultStatus ret)

Parameters

Type	Name	Description
TStorageType	StorageType
string	ExtensionTypeId
bool	Disabled
TResultStatus	ret

SetExtensionSetting(TStorageType, string, string, string, out TResultStatus)

Declaration

void SetExtensionSetting(TStorageType StorageType, string ExtensionTypeId, string Key, string Value, out TResultStatus ret)

Parameters

Type	Name	Description
TStorageType	StorageType
string	ExtensionTypeId
string	Key
string	Value
TResultStatus	ret

SetFieldInherited(TStorageType, string, TStorageField, out TResultStatus)

Declaration

void SetFieldInherited(TStorageType StorageType, string EntityIdent, TStorageField field, out TResultStatus ret)

Parameters

Type	Name	Description
TStorageType	StorageType
string	EntityIdent
TStorageField	field
TResultStatus	ret

SetLibraryDisabled(TStorageType, string, bool, out TResultStatus)

Declaration

void SetLibraryDisabled(TStorageType StorageType, string LibraryPath, bool Disabled, out TResultStatus ret)

Parameters

Type	Name	Description
TStorageType	StorageType
string	LibraryPath
bool	Disabled
TResultStatus	ret

UnRegisterLibrary(string, out TResultStatus)

Declaration

void UnRegisterLibrary(string LibraryPath, out TResultStatus ret)

Parameters

Type	Name	Description
string	LibraryPath
TResultStatus	ret