IEDMS_DXPServerManager interface

No description yet.

public interface IEDMS_DXPServerManager

Namespace: DXP · Assembly: Altium.SDK.Interfaces

Properties

Property	Type	Access	Description
IsCloudServerOption	bool	get; set

IsCloudServerOption

No description yet.

bool GetIsCloudServerOption();
void SetIsCloudServerOption(bool argValue);

Type: bool · Access: read/write

Methods

Method	Returns	Description
GetCachedSettingSafe	bool
GetCommentsService	IEDMS_CommentsService
GetConfigManager	IDMS_ConfigurationManager
GetDictionariesManagerWrapper	IEDMS_DictionariesManagerWrapper
GetDiscoveryService	IEDMS_DiscoveryServiceManager
GetEDS	IEDMS_EDS
GetEnterpriseVault	IEDMS_Vault
GetLibraryService	IEDMS_LibraryService
GetNotificationService	IEDMS_NotificationService
GetPlmSyncService	IEDMS_PlmSyncService
GetProjectsService	IEDMS_ManagedProjectsService
GetSearchTemplatesService	IEDMS_SearchTemplatesService
GetSessionID	string
GetSettingsService	IEDMS_SettingsService
GetShareManager	IEDM_ShareManager
GetSimpleLockService	IEDMS_SimpleLockService
GetTaskService	IEDMS_TaskService
GetUserInfo	IEDMS_DXPServerUserInfo
GetUserNameByGUID	string
GetUsersInGroup	IStrings
GetVCSManager	IEDMS_VCSManager
IsConnected	bool
LoadConnectionOptions	void
LoadDataFromStorage	string
LoginBySessionID	bool
LoginWithSavedOptions	bool
LoginWithUI	bool
LoginWithWorkspace	bool
Logout	void
RefreshSession	bool
SaveConnectionOptions	void
SaveDataToStorage	bool
SilentLogin	bool

GetCachedSettingSafe

No description yet.

bool GetCachedSettingSafe(string argName, bool argForceRefresh, out string argValue, out string argErrorMessage);

Parameter	Type	Passing
argName	string	value
argForceRefresh	bool	value
argValue	string	out
argErrorMessage	string	out

Returns: bool

GetCommentsService

No description yet.

IEDMS_CommentsService GetCommentsService();

Returns: IEDMS_CommentsService

Extension method of IEDMS_DXPServerManagerHelper (using DXP;).

GetConfigManager

No description yet.

IDMS_ConfigurationManager GetConfigManager();

Returns: IDMS_ConfigurationManager

Extension method of IEDMS_DXPServerManagerHelper (using DXP;).

GetDictionariesManagerWrapper

No description yet.

IEDMS_DictionariesManagerWrapper GetDictionariesManagerWrapper();

Returns: IEDMS_DictionariesManagerWrapper

Extension method of IEDMS_DXPServerManagerHelper (using DXP;).

GetDiscoveryService

No description yet.

IEDMS_DiscoveryServiceManager GetDiscoveryService();

Returns: IEDMS_DiscoveryServiceManager

Extension method of IEDMS_DXPServerManagerHelper (using DXP;).

GetEDS

No description yet.

IEDMS_EDS GetEDS();

Returns: IEDMS_EDS

Extension method of IEDMS_DXPServerManagerHelper (using DXP;).

GetEnterpriseVault

No description yet.

IEDMS_Vault GetEnterpriseVault();

Returns: IEDMS_Vault

Extension method of IEDMS_DXPServerManagerHelper (using DXP;).

GetLibraryService

No description yet.

IEDMS_LibraryService GetLibraryService();

Returns: IEDMS_LibraryService

Extension method of IEDMS_DXPServerManagerHelper (using DXP;).

GetNotificationService

No description yet.

IEDMS_NotificationService GetNotificationService();

Returns: IEDMS_NotificationService

Extension method of IEDMS_DXPServerManagerHelper (using DXP;).

GetPlmSyncService

No description yet.

IEDMS_PlmSyncService GetPlmSyncService();

Returns: IEDMS_PlmSyncService

Extension method of IEDMS_DXPServerManagerHelper (using DXP;).

GetProjectsService

No description yet.

IEDMS_ManagedProjectsService GetProjectsService();

Returns: IEDMS_ManagedProjectsService

Extension method of IEDMS_DXPServerManagerHelper (using DXP;).

GetSearchTemplatesService

No description yet.

IEDMS_SearchTemplatesService GetSearchTemplatesService();

Returns: IEDMS_SearchTemplatesService

Extension method of IEDMS_DXPServerManagerHelper (using DXP;).

GetSessionID

No description yet.

string GetSessionID();

Returns: string

GetSettingsService

No description yet.

IEDMS_SettingsService GetSettingsService();

Returns: IEDMS_SettingsService

Extension method of IEDMS_DXPServerManagerHelper (using DXP;).

GetShareManager

No description yet.

IEDM_ShareManager GetShareManager();

Returns: IEDM_ShareManager

Extension method of IEDMS_DXPServerManagerHelper (using DXP;).

GetSimpleLockService

No description yet.

IEDMS_SimpleLockService GetSimpleLockService();

Returns: IEDMS_SimpleLockService

Extension method of IEDMS_DXPServerManagerHelper (using DXP;).

GetTaskService

No description yet.

IEDMS_TaskService GetTaskService();

Returns: IEDMS_TaskService

Extension method of IEDMS_DXPServerManagerHelper (using DXP;).

Examples: Extension_PartRequest

GetUserInfo

No description yet.

IEDMS_DXPServerUserInfo GetUserInfo();

Returns: IEDMS_DXPServerUserInfo

Extension method of IEDMS_DXPServerManagerHelper (using DXP;).

GetUserNameByGUID

No description yet.

string GetUserNameByGUID(string argGUID);

Parameter	Type	Passing
argGUID	string	value

Returns: string

GetUsersInGroup

No description yet.

IStrings GetUsersInGroup(string argGroupGUID);

Parameter	Type	Passing
argGroupGUID	string	value

Returns: IStrings

Extension method of IEDMS_DXPServerManagerHelper (using DXP;).

GetVCSManager

No description yet.

IEDMS_VCSManager GetVCSManager();

Returns: IEDMS_VCSManager

Extension method of IEDMS_DXPServerManagerHelper (using DXP;).

IsConnected

No description yet.

bool IsConnected();

Returns: bool

LoadConnectionOptions

No description yet.

void LoadConnectionOptions(out string argAddress, out string argUserName, out string argPassword, out bool argSaveData, out bool argAutoLogin);

Parameter	Type	Passing
argAddress	string	out
argUserName	string	out
argPassword	string	out
argSaveData	bool	out
argAutoLogin	bool	out

Returns: nothing (void)

LoadDataFromStorage

No description yet.

string LoadDataFromStorage(string argGUID);

Parameter	Type	Passing
argGUID	string	value

Returns: string

LoginBySessionID

No description yet.

bool LoginBySessionID(string argServer, string argSessionID);

Parameter	Type	Passing
argServer	string	value
argSessionID	string	value

Returns: bool

LoginWithSavedOptions

No description yet.

bool LoginWithSavedOptions(bool argForce);

Parameter	Type	Passing
argForce	bool	value

Returns: bool

LoginWithUI

No description yet.

bool LoginWithUI(string argDefaultServer);

Parameter	Type	Passing
argDefaultServer	string	value

Returns: bool

LoginWithWorkspace

No description yet.

bool LoginWithWorkspace(string argDefaultServer);

Parameter	Type	Passing
argDefaultServer	string	value

Returns: bool

Logout

No description yet.

void Logout();

Returns: nothing (void)

RefreshSession

No description yet.

bool RefreshSession();

Returns: bool

SaveConnectionOptions

No description yet.

void SaveConnectionOptions(string argAddress, string argUserName, string argPassword, bool argSaveData, bool argAutoLogin);

Parameter	Type	Passing
argAddress	string	value
argUserName	string	value
argPassword	string	value
argSaveData	bool	value
argAutoLogin	bool	value

Returns: nothing (void)

SaveDataToStorage

No description yet.

bool SaveDataToStorage(string argGUID, string argDATA);

Parameter	Type	Passing
argGUID	string	value
argDATA	string	value

Returns: bool

SilentLogin

No description yet.

bool SilentLogin(string argServer, string argUser, string argPassword, bool argSaveData, bool argEnableAutoLogin, bool argNtlmAuth);

Parameter	Type	Passing
argServer	string	value
argUser	string	value
argPassword	string	value
argSaveData	bool	value
argEnableAutoLogin	bool	value
argNtlmAuth	bool	value

Returns: bool

Returned by

IEDMS_GetDXPServerManager.GetDXPServerManagerInterface, Utils.GetDXPServerManager, Utils.GetDXPServerManager

Examples

Used in the SDK examples: Extension_PartRequest.