# IDXPAltiumPortal interface

*No description yet.*

```csharp
public interface IDXPAltiumPortal
```

**Namespace:** DXP · **Assembly:** Altium.SDK.Interfaces

## Methods

| Method | Returns | Description |
| --- | --- | --- |
| [AddAltiumPortalEvent](#addaltiumportalevent) | `void` |  |
| [FullName](#fullname) | `string` |  |
| [GetOperatorDetails](#getoperatordetails) | `void` |  |
| [GetPRT_GlobalServiceUrl](#getprt_globalserviceurl) | `string` |  |
| [IsBusy](#isbusy) | `bool` |  |
| [LoggedIn](#loggedin) | `bool` |  |
| [LoggingIn](#loggingin) | `bool` |  |
| [Login](#login) | `void` |  |
| [LoginBySessionID](#loginbysessionid) | `void` |  |
| [LoginWithParams](#loginwithparams) | `void` |  |
| [Logout](#logout) | `bool` |  |
| [LogoutWithParams](#logoutwithparams) | `bool` |  |
| [OperatorAccountName](#operatoraccountname) | `string` |  |
| [Password](#password) | `string` |  |
| [PortalSessionHandle](#portalsessionhandle) | `string` |  |
| [ResetPassWord](#resetpassword) | `void` |  |
| [UserName](#username) | `string` |  |

### AddAltiumPortalEvent

*No description yet.*

```csharp
void AddAltiumPortalEvent(string argEventType);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `argEventType` | `string` | value |

**Returns:** nothing (`void`)

### FullName

*No description yet.*

```csharp
string FullName();
```

**Returns:** `string`

### GetOperatorDetails

*No description yet.*

```csharp
void GetOperatorDetails();
```

**Returns:** nothing (`void`)

### GetPRT_GlobalServiceUrl

*No description yet.*

```csharp
string GetPRT_GlobalServiceUrl(string argServiceName);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `argServiceName` | `string` | value |

**Returns:** `string`

### IsBusy

*No description yet.*

```csharp
bool IsBusy();
```

**Returns:** `bool`

### LoggedIn

*No description yet.*

```csharp
bool LoggedIn();
```

**Returns:** `bool`

### LoggingIn

*No description yet.*

```csharp
bool LoggingIn();
```

**Returns:** `bool`

### Login

*No description yet.*

```csharp
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](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/TLoginOptionSet.md) | 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.*

```csharp
void LoginBySessionID(bool argWaitForResult, string argSessionHandle);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `argWaitForResult` | `bool` | value |
| `argSessionHandle` | `string` | value |

**Returns:** nothing (`void`)

### LoginWithParams

*No description yet.*

```csharp
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](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/TLoginOptionSet.md) | 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.*

```csharp
bool Logout();
```

**Returns:** `bool`

### LogoutWithParams

*No description yet.*

```csharp
bool LogoutWithParams(string argParameters);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `argParameters` | `string` | value |

**Returns:** `bool`

### OperatorAccountName

*No description yet.*

```csharp
string OperatorAccountName();
```

**Returns:** `string`

### Password

*No description yet.*

```csharp
string Password();
```

**Returns:** `string`

### PortalSessionHandle

*No description yet.*

```csharp
string PortalSessionHandle();
```

**Returns:** `string`

### ResetPassWord

*No description yet.*

```csharp
void ResetPassWord();
```

**Returns:** nothing (`void`)

### UserName

*No description yet.*

```csharp
string UserName();
```

**Returns:** `string`

## Returned by

[IClient.GetDXPAltiumPortal](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IClient.md#getdxpaltiumportal)