Interface IPartnerAgent

Interface for the Partner Agent Agent with functionality specific for SuperOffice Partners

Namespace: SuperOffice.CRM.Services

Assembly: SuperOffice.Services.dll

Syntax

[Agent("Partner Agent", "Interface for the Partner Agent. Agent with functionality specific for SuperOffice Partners")]
public interface IPartnerAgent : IAgent

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (PartnerAgent agent = new PartnerAgent())
     {
        // call methods on agent here...
     }
  }

Methods

CreateOrUpdateWebPanel(String, String, String, String, Navigation, UrlEncoding, Boolean, Boolean)

Create a web panel in the logged in users' installation of SuperOffice CRM online. The panel will automatically be registered to the currently authenticated ApplicationId.

Declaration

string CreateOrUpdateWebPanel(string identifier, string displayName, string displayDescription, string url, Navigation visibleIn, UrlEncoding urlEncoding, bool onSalesMarketingWeb, bool onSalesMarketingPocket)

Parameters

Type	Name	Description
String	identifier	The string constant used by the Partner Application to identify this web panel
String	displayName	The name of the panel as displayed in the GUI; may be multi-language syntax
String	displayDescription	The tooltip of the panel as displayed in the GUI; may be multi-language syntax
String	url	The url (target) of the panel; may contain merge tags
Navigation	visibleIn	Where should the URL appear
UrlEncoding	urlEncoding	The encoding of the URL
Boolean	onSalesMarketingWeb	Is the webpanel visible when user is on the SM Web client
Boolean	onSalesMarketingPocket	Is the webpanel visible when user is on the SM Pocket client

Returns

Type	Description
String	The 'window name' of the panel, which can be used as part of the soprotocol string to navigate to the web panel

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (PartnerAgent agent = new PartnerAgent())
     {
        // call methods on agent here...
     }
  }

DeleteMyWebPanels()

Irrevocably delete all web panels registered by this ApplicationId

Declaration

void DeleteMyWebPanels()

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (PartnerAgent agent = new PartnerAgent())
     {
        // call methods on agent here...
     }
  }

DeleteWebPanel(String)

Irrevocably delete all information related to this web panel; no undo

Declaration

void DeleteWebPanel(string identifier)

Parameters

Type	Name	Description
String	identifier	The string constant used by the Partner Application to identify this web panel

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (PartnerAgent agent = new PartnerAgent())
     {
        // call methods on agent here...
     }
  }

GetMyWebPanels()

Get all web panels registered by this ApplicationId

Declaration

PartnerWebPanel[] GetMyWebPanels()

Returns

Type	Description
PartnerWebPanel[]	Array of PartnerWebPanel entities

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (PartnerAgent agent = new PartnerAgent())
     {
        // call methods on agent here...
     }
  }

ResumeWebPanel(String)

Undo a Suspend, so that the Web Panel is visible to users again

Declaration

void ResumeWebPanel(string identifier)

Parameters

Type	Name	Description
String	identifier	The string constant used by the Partner Application to identify this web panel

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (PartnerAgent agent = new PartnerAgent())
     {
        // call methods on agent here...
     }
  }

SuspendWebPanel(String)

The web panel is no longer visible to the users, but all settings are kept

Declaration

void SuspendWebPanel(string identifier)

Parameters

Type	Name	Description
String	identifier	The string constant used by the Partner Application to identify this web panel

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (PartnerAgent agent = new PartnerAgent())
     {
        // call methods on agent here...
     }
  }