Class ExtAppEntity

The ext app entity contains information on an external application

Carrier object for ExtAppEntity. Services for the ExtAppEntity Carrier is available from the IListAgent.
Inheritance
Object
ExtAppEntity
Namespace: SuperOffice.CRM.Services
Assembly: SuperOffice.Services.dll
Syntax
public class ExtAppEntity : Carrier
Examples

Get ExtAppEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ListAgent();
    var extAppEntity = agent.GetExtAppEntity( 123 );
 }

Constructors

ExtAppEntity()

Default constructor

Declaration
public ExtAppEntity()
Examples

Get ExtAppEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ListAgent();
    var extAppEntity = agent.GetExtAppEntity( 123 );
 }
See Also

Properties

Deleted

True if the application is marked as deleted

Declaration
public virtual bool Deleted { get; set; }
Property Value
Type Description
Boolean
Examples

Get ExtAppEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ListAgent();
    var extAppEntity = agent.GetExtAppEntity( 123 );
 }
See Also

ExecuteOnEvent

Events that cause automatic execution of this app

Declaration
public virtual ExecuteOnEvent ExecuteOnEvent { get; set; }
Property Value
Type Description
ExecuteOnEvent
Examples

Get ExtAppEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ListAgent();
    var extAppEntity = agent.GetExtAppEntity( 123 );
 }
See Also

ExtAppId

The identity of the external app

Declaration
public virtual int ExtAppId { get; set; }
Property Value
Type Description
Int32
Examples

Get ExtAppEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ListAgent();
    var extAppEntity = agent.GetExtAppEntity( 123 );
 }
See Also

Filename

Filename of the programfile

Declaration
public virtual string Filename { get; set; }
Property Value
Type Description
String
Examples

Get ExtAppEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ListAgent();
    var extAppEntity = agent.GetExtAppEntity( 123 );
 }
See Also

Icon

The id of the icon of the external app

Declaration
public virtual short Icon { get; set; }
Property Value
Type Description
Int16
Examples

Get ExtAppEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ListAgent();
    var extAppEntity = agent.GetExtAppEntity( 123 );
 }
See Also

Name

The name of the web panel

Declaration
public virtual string Name { get; set; }
Property Value
Type Description
String
Examples

Get ExtAppEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ListAgent();
    var extAppEntity = agent.GetExtAppEntity( 123 );
 }
See Also

OnCentral

Is the application visible when user is on central database

Declaration
public virtual bool OnCentral { get; set; }
Property Value
Type Description
Boolean
Examples

Get ExtAppEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ListAgent();
    var extAppEntity = agent.GetExtAppEntity( 123 );
 }
See Also

OnSalesMarketingPocket

Is the webpanel visible when user is on pocket client

Declaration
public virtual bool OnSalesMarketingPocket { get; set; }
Property Value
Type Description
Boolean
Examples

Get ExtAppEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ListAgent();
    var extAppEntity = agent.GetExtAppEntity( 123 );
 }
See Also

OnSatellite

Is the application visible when user is on a satellite

Declaration
public virtual bool OnSatellite { get; set; }
Property Value
Type Description
Boolean
Examples

Get ExtAppEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ListAgent();
    var extAppEntity = agent.GetExtAppEntity( 123 );
 }
See Also

OnTravel

Is the application visible when user is on travel

Declaration
public virtual bool OnTravel { get; set; }
Property Value
Type Description
Boolean
Examples

Get ExtAppEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ListAgent();
    var extAppEntity = agent.GetExtAppEntity( 123 );
 }
See Also

Parameters

<template variable> <other template variable>

Declaration
public virtual string Parameters { get; set; }
Property Value
Type Description
String
Examples

Get ExtAppEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ListAgent();
    var extAppEntity = agent.GetExtAppEntity( 123 );
 }
See Also

Path

Path where the programfile is located; if empty, PATH is used

Declaration
public virtual string Path { get; set; }
Property Value
Type Description
String
Examples

Get ExtAppEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ListAgent();
    var extAppEntity = agent.GetExtAppEntity( 123 );
 }
See Also

Rank

The rank of the application

Declaration
public virtual int Rank { get; set; }
Property Value
Type Description
Int32
Examples

Get ExtAppEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ListAgent();
    var extAppEntity = agent.GetExtAppEntity( 123 );
 }
See Also

ShowInAddressBar

Does the webpanel have an address bar

Declaration
public virtual bool ShowInAddressBar { get; set; }
Property Value
Type Description
Boolean
Examples

Get ExtAppEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ListAgent();
    var extAppEntity = agent.GetExtAppEntity( 123 );
 }
See Also

ShowInMenuBar

Does the application have a menu bar

Declaration
public virtual bool ShowInMenuBar { get; set; }
Property Value
Type Description
Boolean
Examples

Get ExtAppEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ListAgent();
    var extAppEntity = agent.GetExtAppEntity( 123 );
 }
See Also

ShowInStatusBar

Does the webpanel have a status bar

Declaration
public virtual bool ShowInStatusBar { get; set; }
Property Value
Type Description
Boolean
Examples

Get ExtAppEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ListAgent();
    var extAppEntity = agent.GetExtAppEntity( 123 );
 }
See Also

ShowInToolBar

Does the webpanel have a toolbar

Declaration
public virtual bool ShowInToolBar { get; set; }
Property Value
Type Description
Boolean
Examples

Get ExtAppEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ListAgent();
    var extAppEntity = agent.GetExtAppEntity( 123 );
 }
See Also

ShowState

The application is shown in which state Minimized, Maximized or Restored

Declaration
public virtual ShowState ShowState { get; set; }
Property Value
Type Description
ShowState
Examples

Get ExtAppEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ListAgent();
    var extAppEntity = agent.GetExtAppEntity( 123 );
 }
See Also

Tooltip

The tooltip of the web panel

Declaration
public virtual string Tooltip { get; set; }
Property Value
Type Description
String
Examples

Get ExtAppEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ListAgent();
    var extAppEntity = agent.GetExtAppEntity( 123 );
 }
See Also

VisibleIn

The application is visible in

Declaration
public virtual Navigation VisibleIn { get; set; }
Property Value
Type Description
Navigation
Examples

Get ExtAppEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ListAgent();
    var extAppEntity = agent.GetExtAppEntity( 123 );
 }
See Also

WaitToFinish

True if the application shall wait for fininsh event

Declaration
public virtual bool WaitToFinish { get; set; }
Property Value
Type Description
Boolean
Examples

Get ExtAppEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ListAgent();
    var extAppEntity = agent.GetExtAppEntity( 123 );
 }
See Also

Workdir

Directory set to current when loading the application, if different from application's own

Declaration
public virtual string Workdir { get; set; }
Property Value
Type Description
String
Examples

Get ExtAppEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ListAgent();
    var extAppEntity = agent.GetExtAppEntity( 123 );
 }
See Also

Methods

ToString()

Returns the carrier contents as a formatted string.

Declaration
public override string ToString()
Returns
Type Description
String

The carrier contents.
Examples

Get ExtAppEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ListAgent();
    var extAppEntity = agent.GetExtAppEntity( 123 );
 }
See Also

ToString(String)

Returns the carrier contents as a formatted string, useful for debugging. Each line in the output is prefixed with the input value.

Declaration
public string ToString(string prefix)
Parameters
Type Name Description
String prefix

The line prefix (typically used for indenting)
Returns
Type Description
String

The carrier contents.
Examples

Get ExtAppEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ListAgent();
    var extAppEntity = agent.GetExtAppEntity( 123 );
 }
See Also

See Also