> ## Documentation Index
> Fetch the complete documentation index at: https://docs.superoffice.com/llms.txt
> Use this file to discover all available pages before exploring further.

# NSExtAppEntity

> Contains information on an external application.

Contains information on an external application.

## Constructors

### NSExtAppEntity()

```crmscript theme={null}
NSExtAppEntity
```

Initializes a new instance of the NSExtAppEntity class.

## Methods

## GetDeleted()

```crmscript theme={null}
Bool GetDeleted()
```

**Returns:** [CRMScript.Global.Bool](CRMScript.Global.Bool) - True if the application is marked as deleted.

**Example:**

```crmscript theme={null}
NSExtAppEntity thing;
Bool deleted = thing.GetDeleted();
```

## GetExecuteOnEvent()

```crmscript theme={null}
NSExecuteOnEvent GetExecuteOnEvent()
```

**Returns:** [CRMScript.NetServer.NSExecuteOnEvent](CRMScript.NetServer.NSExecuteOnEvent) - Events that cause automatic execution of this app. See \<xref href="CRMScript.NetServer.ExecuteOnEvent" data-throw-if-not-resolved="false">\</xref>

**Example:**

```crmscript theme={null}
NSExtAppEntity thing;
NSExecuteOnEvent executeOnEvent = thing.GetExecuteOnEvent();
```

## GetExtAppId()

```crmscript theme={null}
Integer GetExtAppId()
```

**Returns:** [CRMScript.Global.Integer](CRMScript.Global.Integer) - The identity of the external app.

**Example:**

```crmscript theme={null}
NSExtAppEntity thing;
Integer extAppId = thing.GetExtAppId();
```

## GetFilename()

```crmscript theme={null}
String GetFilename()
```

**Returns:** [CRMScript.Global.String](CRMScript.Global.String) - Filename of the programfile.

**Example:**

```crmscript theme={null}
NSExtAppEntity thing;
String filename = thing.GetFilename();
```

## GetIcon()

```crmscript theme={null}
Integer GetIcon()
```

**Returns:** [CRMScript.Global.Integer](CRMScript.Global.Integer) - The ID of the icon of the external app.

**Example:**

```crmscript theme={null}
NSExtAppEntity thing;
Integer icon = thing.GetIcon();
```

## GetName()

```crmscript theme={null}
String GetName()
```

**Returns:** [CRMScript.Global.String](CRMScript.Global.String) - The name of the web panel.

**Example:**

```crmscript theme={null}
NSExtAppEntity thing;
String name = thing.GetName();
```

## GetOnCentral()

```crmscript theme={null}
Bool GetOnCentral()
```

**Returns:** [CRMScript.Global.Bool](CRMScript.Global.Bool) - Is the application visible when user is on central database.

**Example:**

```crmscript theme={null}
NSExtAppEntity thing;
Bool onCentral = thing.GetOnCentral();
```

## GetOnSalesMarketingPocket()

```crmscript theme={null}
Bool GetOnSalesMarketingPocket()
```

**Returns:** [CRMScript.Global.Bool](CRMScript.Global.Bool) - Is the web panel visible when user is on pocket client.

**Example:**

```crmscript theme={null}
NSExtAppEntity thing;
Bool onSalesMarketingPocket = thing.GetOnSalesMarketingPocket();
```

## GetOnSatellite()

```crmscript theme={null}
Bool GetOnSatellite()
```

**Returns:** [CRMScript.Global.Bool](CRMScript.Global.Bool) - Is the application visible when user is on a satellite.

**Example:**

```crmscript theme={null}
NSExtAppEntity thing;
Bool onSatellite = thing.GetOnSatellite();
```

## GetOnTravel()

```crmscript theme={null}
Bool GetOnTravel()
```

**Returns:** [CRMScript.Global.Bool](CRMScript.Global.Bool) - Is the application visible when user is on travel.

**Example:**

```crmscript theme={null}
NSExtAppEntity thing;
Bool onTravel = thing.GetOnTravel();
```

## GetParameters()

```crmscript theme={null}
String GetParameters()
```

**Returns:** [CRMScript.Global.String](CRMScript.Global.String) - \<template variable>\<other template variable>

**Example:**

```crmscript theme={null}
NSExtAppEntity thing;
String parameters = thing.GetParameters();
```

## GetPath()

```crmscript theme={null}
String GetPath()
```

**Returns:** [CRMScript.Global.String](CRMScript.Global.String) - Path where the programfile is located; if empty, PATH is used.

**Example:**

```crmscript theme={null}
NSExtAppEntity thing;
String path = thing.GetPath();
```

## GetRank()

```crmscript theme={null}
Integer GetRank()
```

**Returns:** [CRMScript.Global.Integer](CRMScript.Global.Integer) - The rank of the application.

**Example:**

```crmscript theme={null}
NSExtAppEntity thing;
Integer rank = thing.GetRank();
```

## GetShowInAddressBar()

```crmscript theme={null}
Bool GetShowInAddressBar()
```

**Returns:** [CRMScript.Global.Bool](CRMScript.Global.Bool) - Does the web panel have an address bar.

**Example:**

```crmscript theme={null}
NSExtAppEntity thing;
Bool showInAddressBar = thing.GetShowInAddressBar();
```

## GetShowInMenuBar()

```crmscript theme={null}
Bool GetShowInMenuBar()
```

**Returns:** [CRMScript.Global.Bool](CRMScript.Global.Bool) - Does the application have a menu bar.

**Example:**

```crmscript theme={null}
NSExtAppEntity thing;
Bool showInMenuBar = thing.GetShowInMenuBar();
```

## GetShowInStatusBar()

```crmscript theme={null}
Bool GetShowInStatusBar()
```

**Returns:** [CRMScript.Global.Bool](CRMScript.Global.Bool) - Does the web panel have a status bar.

**Example:**

```crmscript theme={null}
NSExtAppEntity thing;
Bool showInStatusBar = thing.GetShowInStatusBar();
```

## GetShowInToolBar()

```crmscript theme={null}
Bool GetShowInToolBar()
```

**Returns:** [CRMScript.Global.Bool](CRMScript.Global.Bool) - Does the web panel have a toolbar.

**Example:**

```crmscript theme={null}
NSExtAppEntity thing;
Bool showInToolBar = thing.GetShowInToolBar();
```

## GetShowState()

```crmscript theme={null}
Integer GetShowState()
```

**Returns:** [CRMScript.Global.Integer](CRMScript.Global.Integer) - The application is shown in which state Minimized, Maximized or Restored. See \<xref href="CRMScript.NetServer.ShowState" data-throw-if-not-resolved="false">\</xref>

**Example:**

```crmscript theme={null}
NSExtAppEntity thing;
Integer showState = thing.GetShowState();
```

## GetTooltip()

```crmscript theme={null}
String GetTooltip()
```

**Returns:** [CRMScript.Global.String](CRMScript.Global.String) - The tooltip of the web panel.

**Example:**

```crmscript theme={null}
NSExtAppEntity thing;
String tooltip = thing.GetTooltip();
```

## GetVisibleIn()

```crmscript theme={null}
Integer GetVisibleIn()
```

**Returns:** [CRMScript.Global.Integer](CRMScript.Global.Integer) - The application is visible in. See \<xref href="CRMScript.NetServer.Navigation" data-throw-if-not-resolved="false">\</xref>

**Example:**

```crmscript theme={null}
NSExtAppEntity thing;
Integer visibleIn = thing.GetVisibleIn();
```

## GetWaitToFinish()

```crmscript theme={null}
Bool GetWaitToFinish()
```

**Returns:** [CRMScript.Global.Bool](CRMScript.Global.Bool) - True if the application shall wait for finish event.

**Example:**

```crmscript theme={null}
NSExtAppEntity thing;
Bool waitToFinish = thing.GetWaitToFinish();
```

## GetWorkdir()

```crmscript theme={null}
String GetWorkdir()
```

**Returns:** [CRMScript.Global.String](CRMScript.Global.String) - Directory set to current when loading the application, if different from application's own.

**Example:**

```crmscript theme={null}
NSExtAppEntity thing;
String workdir = thing.GetWorkdir();
```

## SetDeleted(Bool)

```crmscript theme={null}
Void SetDeleted(Bool deleted)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSExtAppEntity thing;
Bool deleted;
thing.SetDeleted(deleted);
```

## SetExecuteOnEvent(NSExecuteOnEvent)

```crmscript theme={null}
Void SetExecuteOnEvent(NSExecuteOnEvent executeOnEvent)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSExtAppEntity thing;
NSExecuteOnEvent executeOnEvent;
thing.SetExecuteOnEvent(executeOnEvent);
```

## SetExtAppId(Integer)

```crmscript theme={null}
Void SetExtAppId(Integer extAppId)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSExtAppEntity thing;
Integer extAppId;
thing.SetExtAppId(extAppId);
```

## SetFilename(String)

```crmscript theme={null}
Void SetFilename(String filename)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSExtAppEntity thing;
String filename;
thing.SetFilename(filename);
```

## SetIcon(Integer)

```crmscript theme={null}
Void SetIcon(Integer icon)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSExtAppEntity thing;
Integer icon;
thing.SetIcon(icon);
```

## SetName(String)

```crmscript theme={null}
Void SetName(String name)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSExtAppEntity thing;
String name;
thing.SetName(name);
```

## SetOnCentral(Bool)

```crmscript theme={null}
Void SetOnCentral(Bool onCentral)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSExtAppEntity thing;
Bool onCentral;
thing.SetOnCentral(onCentral);
```

## SetOnSalesMarketingPocket(Bool)

```crmscript theme={null}
Void SetOnSalesMarketingPocket(Bool onSalesMarketingPocket)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSExtAppEntity thing;
Bool onSalesMarketingPocket;
thing.SetOnSalesMarketingPocket(onSalesMarketingPocket);
```

## SetOnSatellite(Bool)

```crmscript theme={null}
Void SetOnSatellite(Bool onSatellite)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSExtAppEntity thing;
Bool onSatellite;
thing.SetOnSatellite(onSatellite);
```

## SetOnTravel(Bool)

```crmscript theme={null}
Void SetOnTravel(Bool onTravel)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSExtAppEntity thing;
Bool onTravel;
thing.SetOnTravel(onTravel);
```

## SetParameters(String)

```crmscript theme={null}
Void SetParameters(String parameters)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSExtAppEntity thing;
String parameters;
thing.SetParameters(parameters);
```

## SetPath(String)

```crmscript theme={null}
Void SetPath(String path)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSExtAppEntity thing;
String path;
thing.SetPath(path);
```

## SetRank(Integer)

```crmscript theme={null}
Void SetRank(Integer rank)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSExtAppEntity thing;
Integer rank;
thing.SetRank(rank);
```

## SetShowInAddressBar(Bool)

```crmscript theme={null}
Void SetShowInAddressBar(Bool showInAddressBar)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSExtAppEntity thing;
Bool showInAddressBar;
thing.SetShowInAddressBar(showInAddressBar);
```

## SetShowInMenuBar(Bool)

```crmscript theme={null}
Void SetShowInMenuBar(Bool showInMenuBar)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSExtAppEntity thing;
Bool showInMenuBar;
thing.SetShowInMenuBar(showInMenuBar);
```

## SetShowInStatusBar(Bool)

```crmscript theme={null}
Void SetShowInStatusBar(Bool showInStatusBar)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSExtAppEntity thing;
Bool showInStatusBar;
thing.SetShowInStatusBar(showInStatusBar);
```

## SetShowInToolBar(Bool)

```crmscript theme={null}
Void SetShowInToolBar(Bool showInToolBar)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSExtAppEntity thing;
Bool showInToolBar;
thing.SetShowInToolBar(showInToolBar);
```

## SetShowState(Integer)

```crmscript theme={null}
Void SetShowState(Integer showState)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSExtAppEntity thing;
Integer showState;
thing.SetShowState(showState);
```

## SetTooltip(String)

```crmscript theme={null}
Void SetTooltip(String tooltip)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSExtAppEntity thing;
String tooltip;
thing.SetTooltip(tooltip);
```

## SetVisibleIn(Integer)

```crmscript theme={null}
Void SetVisibleIn(Integer visibleIn)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSExtAppEntity thing;
Integer visibleIn;
thing.SetVisibleIn(visibleIn);
```

## SetWaitToFinish(Bool)

```crmscript theme={null}
Void SetWaitToFinish(Bool waitToFinish)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSExtAppEntity thing;
Bool waitToFinish;
thing.SetWaitToFinish(waitToFinish);
```

## SetWorkdir(String)

```crmscript theme={null}
Void SetWorkdir(String workdir)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSExtAppEntity thing;
String workdir;
thing.SetWorkdir(workdir);
```


## Related topics

- [NSListAgent](/en/automation/crmscript/reference/CRMScript.NetServer.NSListAgent.md)
- [Save Ext App Entity](/en/api/reference/restful/agent/list_agent/save-ext-app-entity.md)
- [Get Ext App Entity](/en/api/reference/restful/agent/list_agent/get-ext-app-entity.md)
- [Create Default Ext App Entity](/en/api/reference/restful/agent/list_agent/create-default-ext-app-entity.md)
- [SuperOffice.WebApi.Data.ExtAppEntity](/en/api/reference/webapi/SuperOffice.WebApi.Data.ExtAppEntity.md)
- [SuperOffice.WebApi.Agents.IListAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.IListAgent.md)