IDXPAltiumPortal interface
No description yet.
public interface IDXPAltiumPortal
Namespace: DXP · Assembly: Altium.SDK.Interfaces
Methods
| Method | Returns | Description |
|---|---|---|
| AddAltiumPortalEvent | void | |
| FullName | string | |
| GetOperatorDetails | void | |
| GetPRT_GlobalServiceUrl | string | |
| IsBusy | bool | |
| LoggedIn | bool | |
| LoggingIn | bool | |
| Login | void | |
| LoginBySessionID | void | |
| LoginWithParams | void | |
| Logout | bool | |
| LogoutWithParams | bool | |
| OperatorAccountName | string | |
| Password | string | |
| PortalSessionHandle | string | |
| ResetPassWord | void | |
| UserName | string |
AddAltiumPortalEvent
No description yet.
void AddAltiumPortalEvent(string argEventType);
| Parameter | Type | Passing |
|---|---|---|
argEventType | string | value |
Returns: nothing (void)
FullName
No description yet.
string FullName();
Returns: string
GetOperatorDetails
No description yet.
void GetOperatorDetails();
Returns: nothing (void)
GetPRT_GlobalServiceUrl
No description yet.
string GetPRT_GlobalServiceUrl(string argServiceName);
| Parameter | Type | Passing |
|---|---|---|
argServiceName | string | value |
Returns: string
IsBusy
No description yet.
bool IsBusy();
Returns: bool
LoggedIn
No description yet.
bool LoggedIn();
Returns: bool
LoggingIn
No description yet.
bool LoggingIn();
Returns: bool
Login
No description yet.
void Login(bool argWaitForResult, string argCaption, TLoginOptionSet argFlags);
void Login(bool argWaitForResult, string argCaption, ITransportSet argFlags);
| Parameter | Type | Passing |
|---|---|---|
argWaitForResult | bool | value |
argCaption | string | value |
argFlags | TLoginOptionSet | value |
Returns: nothing (void)
The first overload is an extension method of IDXPAltiumPortalHelper (using DXP;) with typed parameters; the second is declared by the interface.
LoginBySessionID
No description yet.
void LoginBySessionID(bool argWaitForResult, string argSessionHandle);
| Parameter | Type | Passing |
|---|---|---|
argWaitForResult | bool | value |
argSessionHandle | string | value |
Returns: nothing (void)
LoginWithParams
No description yet.
void LoginWithParams(bool argWaitForResult, string argCaption, TLoginOptionSet argFlags, string argParameters);
void LoginWithParams(bool argWaitForResult, string argCaption, ITransportSet argFlags, string argParameters);
| Parameter | Type | Passing |
|---|---|---|
argWaitForResult | bool | value |
argCaption | string | value |
argFlags | TLoginOptionSet | value |
argParameters | string | value |
Returns: nothing (void)
The first overload is an extension method of IDXPAltiumPortalHelper (using DXP;) with typed parameters; the second is declared by the interface.
Logout
No description yet.
bool Logout();
Returns: bool
LogoutWithParams
No description yet.
bool LogoutWithParams(string argParameters);
| Parameter | Type | Passing |
|---|---|---|
argParameters | string | value |
Returns: bool
OperatorAccountName
No description yet.
string OperatorAccountName();
Returns: string
Password
No description yet.
string Password();
Returns: string
PortalSessionHandle
No description yet.
string PortalSessionHandle();
Returns: string
ResetPassWord
No description yet.
void ResetPassWord();
Returns: nothing (void)
UserName
No description yet.
string UserName();
Returns: string