Class CustomerServiceAgent

Facade for the CustomerService Agent Agent used for Customer Service methods

Inheritance

Object

AgentBase<ICustomerServiceAgent>

CustomerServiceAgent

Implements

IDisposable

ICustomerServiceAgent

IAgent

Inherited Members

AgentBase<ICustomerServiceAgent>.Dispose()

AgentBase<ICustomerServiceAgent>.InnerAgent

Namespace: SuperOffice.CRM.Services

Assembly: SuperOffice.Services.dll

Syntax

public class CustomerServiceAgent : AgentBase<ICustomerServiceAgent>, IDisposable, ICustomerServiceAgent, IAgent

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

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

Constructors

CustomerServiceAgent()

Facade for the CustomerService Agent Agent used for Customer Service methods

Declaration

public CustomerServiceAgent()

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

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

Methods

AddMessageFromMailData(Int32, String)

This method will add a message to an existing request in the sam way as importMail would do it from an email. It accepts RFC822 formatted data

Declaration

public TicketInfo AddMessageFromMailData(int ticketId, string data)

Parameters

Type	Name	Description
Int32	ticketId	The id of the ticket to add a message
String	data	RFC822 formatted data to import as a message

Returns

Type	Description
TicketInfo	An object containing some meta data for the ticket

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

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

ChatSessionsForUser()

Get all chat TOPICS which this user is a member of. Members means that you have at least one of: Can Respond, Notifications, Listen or Manager

Declaration

public ChatSession[] ChatSessionsForUser()

Returns

Type	Description
ChatSession[]	Array of chat TOPIC ids the current user can access. NOT chat sessions.

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

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

CheckIfCustomizedTemplates()

Checks whether the core html templates are customized

Declaration

public bool CheckIfCustomizedTemplates()

Returns

Type	Description
Boolean	True if the templates are customized

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

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

CheckSymmetricEncryption(String)

Do a test to check that we are using the same encryption keys

Declaration

public string CheckSymmetricEncryption(string encryptedString)

Parameters

Type	Name	Description
String	encryptedString	An encrypted version of the string

Returns

Type	Description
String	Encrypted version of the string done by NetServer

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

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

CreateDefaultCustomerCenterConfig()

Loading default values into a new CustomerCenterConfig. NetServer calculates default values (e.g. Country) on the entity, which is required when creating/storing a new instance

Declaration

public CustomerCenterConfig CreateDefaultCustomerCenterConfig()

Returns

Type	Description
CustomerCenterConfig	New CustomerCenterConfig with default values

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

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

CreateDefaultMailboxEntity()

Loading default values into a new MailboxEntity. NetServer calculates default values (e.g. Country) on the entity, which is required when creating/storing a new instance

Declaration

public MailboxEntity CreateDefaultMailboxEntity()

Returns

Type	Description
MailboxEntity	New MailboxEntity with default values

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

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

CreateDefaultSmsConfig()

Loading default values into a new SmsConfig. NetServer calculates default values (e.g. Country) on the entity, which is required when creating/storing a new instance

Declaration

public SmsConfig CreateDefaultSmsConfig()

Returns

Type	Description
SmsConfig	New SmsConfig with default values

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

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

CreateSession(String)

Creates a login session for a CS user

Declaration

public CsSessionKey CreateSession(string remoteIp)

Parameters

Type	Name	Description
String	remoteIp	The ip of the client creating the session

Returns

Type	Description
CsSessionKey	The session key information

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

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

CreateTicketFromMailData(Int32, String)

This method create a new ticket in the same way as importMail would import an email. It accepts RFC822 formatted data

Declaration

public TicketInfo CreateTicketFromMailData(int mailboxId, string data)

Parameters

Type	Name	Description
Int32	mailboxId	The id of the Service mailbox
String	data	RFC822 formatted data to import as a ticket

Returns

Type	Description
TicketInfo	An object containing some meta data for the created ticket

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

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

DeleteChatSessions(Int32[])

Deletes the specified chat sessions.

Declaration

public void DeleteChatSessions(int[] ids)

Parameters

Type	Name	Description
Int32[]	ids	The ids of the chat sessions to delete

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

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

DeleteCustomerCenterConfig(Int32)

Deletes the CustomerCenterConfig

Declaration

public void DeleteCustomerCenterConfig(int customerCenterConfigId)

Parameters

Type	Name	Description
Int32	customerCenterConfigId	The identity of the CustomerCenterConfig

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

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

EventHandlerExists(EventHandlerType)

Check if an eventhandler exists for a given enum

Declaration

public bool EventHandlerExists(EventHandlerType eventHandlerType)

Parameters

Type	Name	Description
EventHandlerType	eventHandlerType	The EventHandlerType we are checking

Returns

Type	Description
Boolean	True if it exists

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

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

ExecuteEventHandlers(EventData)

This method will execute event handlers in CRMScript for a given event.

Declaration

public EventData ExecuteEventHandlers(EventData eventData)

Parameters

Type	Name	Description
EventData	eventData	The EventData instance sent to the event handler

Returns

Type	Description
EventData	The EventData instance after event handler execution

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

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

FindTicketsByTitleOrId(String, Int32)

This method wil search for tickets matching title or id

Declaration

public TicketInfo[] FindTicketsByTitleOrId(string titleOrId, int maxRows)

Parameters

Type	Name	Description
String	titleOrId	The search string. If this is a number, it will also search for a matching ticket id
Int32	maxRows	The maximum number of rows to be returned

Returns

Type	Description
TicketInfo[]	An array of objects containing some meta data for matching tickets

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

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

GetAllCustomerCenterConfigs()

Get all rows from cust_config as an array of CustomerCenterConfig entities

Declaration

public CustomerCenterConfig[] GetAllCustomerCenterConfigs()

Returns

Type	Description
CustomerCenterConfig[]	An array of CustomerCenterConfig entities

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

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

GetCustomerCenterConfig(Int32)

Gets a CustomerCenterConfig object.

Declaration

public CustomerCenterConfig GetCustomerCenterConfig(int customerCenterConfigId)

Parameters

Type	Name	Description
Int32	customerCenterConfigId	The identifier of the CustomerCenterConfig object

Returns

Type	Description
CustomerCenterConfig	CustomerCenterConfig

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

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

GetCustomerServiceStartup()

Get the carrier with data that Service needs when starting up

Declaration

public CustomerServiceStartup GetCustomerServiceStartup()

Returns

Type	Description
CustomerServiceStartup	The carrier containing the startup data

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

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

GetCustomerServiceStartupByOwner(Int32)

Get the carrier with data that Service needs when starting up for a specific user

Declaration

public CustomerServiceStartup GetCustomerServiceStartupByOwner(int userId)

Parameters

Type	Name	Description
Int32	userId	The user for which we want to fetch the startup values for

Returns

Type	Description
CustomerServiceStartup	The carrier containing the startup data

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

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

GetFaqForCustomer(Int32)

Get a FAQ entry, ment to be displayed for a customer. This can either be a link to the FAQ entry on Custom Center, or it can be the answer and question. This is dependent on Registry setting with reg_id=157

Declaration

public string GetFaqForCustomer(int faqEntryId)

Parameters

Type	Name	Description
Int32	faqEntryId	The id of the FAQ entry to get. Only FAQ entries with access level public (both for unauthenticated and autenticated customer) will be returned

Returns

Type	Description
String	The FAQ to show to the customer. Either a clickable link or the question/answer itself.

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

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

GetMailboxEntity(Int32)

Gets a MailboxEntity object.

Declaration

public MailboxEntity GetMailboxEntity(int mailboxEntityId)

Parameters

Type	Name	Description
Int32	mailboxEntityId	The identifier of the MailboxEntity object

Returns

Type	Description
MailboxEntity	MailboxEntity

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

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

GetMailboxes()

This method will get all registered mailboxes in Service

Declaration

public Mailbox[] GetMailboxes()

Returns

Type	Description
Mailbox[]	An array of Mailbox objects

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

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

GetParsedTemplate(Int32, Int32, Int32, Int32)

Get a specific langauge version of the reply template, and run this trough the parser

Declaration

public ReplyTemplateParsed GetParsedTemplate(int replyTemplateId, int languageId, int personId, int ticketId)

Parameters

Type	Name	Description
Int32	replyTemplateId	The id of the reply template
Int32	languageId	The language id (prefered language). If 0 is given, the language of the person will be used
Int32	personId	The id of the person that will be populated into the parser
Int32	ticketId	The id of the ticket that will be populated into the parser

Returns

Type	Description
ReplyTemplateParsed	The parsed reply template

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

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

GetPreviewFaqEntry(Int32)

Get a faq entry from its faq entry id

Declaration

public PreviewFaqEntry GetPreviewFaqEntry(int kbEntryId)

Parameters

Type	Name	Description
Int32	kbEntryId	FAQ entry ID

Returns

Type	Description
PreviewFaqEntry	FAQ entry suitable for preview

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

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

GetPreviewQuickReply(Int32)

Get a quick reply from its quick reply id

Declaration

public PreviewQuickReply GetPreviewQuickReply(int quickReplyId)

Parameters

Type	Name	Description
Int32	quickReplyId	Quick reply ID

Returns

Type	Description
PreviewQuickReply	Quick reply suitable for preview

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

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

GetPreviewReplyTemplate(Int32)

Get a reply template from its reply template id

Declaration

public PreviewReplyTemplate GetPreviewReplyTemplate(int replyTemplateId)

Parameters

Type	Name	Description
Int32	replyTemplateId	Reply template ID

Returns

Type	Description
PreviewReplyTemplate	Reply template suitable for preview

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

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

GetProgramUrl(String, Boolean)

This method will convert a module name into a Service URL.

Declaration

public string GetProgramUrl(string programName, bool external)

Parameters

Type	Name	Description
String	programName	In this parameter you must specify which CS program you want to create an URL for. Valid examples are "ticket", "rms", "spm" etc.
Boolean	external	If set to true, this will generate URLs that are accesible from the outside (for example Internet)

Returns

Type	Description
String	Returns a valid Service URL composed of the give parameters.

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

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

GetSmsConfig()

Get the SmsConfig settings for Customer Service sms providers.

Declaration

public SmsConfig GetSmsConfig()

Returns

Type	Description
SmsConfig	Current SMS configuration.

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

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

GetStatistics(StatusScreenPanelType[])

Returns the calculated results for the required statistics for the Customer Service Status Page

Declaration

public StatisticsDataSet[] GetStatistics(StatusScreenPanelType[] functions)

Parameters

Type	Name	Description
StatusScreenPanelType[]	functions	List of functions to calculate and return

Returns

Type	Description
StatisticsDataSet[]	Array of StatisticsDataSet

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

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

GetSystemTemplateSettings()

Returns system template settings

Declaration

public SystemTemplateSettings GetSystemTemplateSettings()

Returns

Type	Description
SystemTemplateSettings	System template settings item

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

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

GetUnparsedTemplate(Int32, Int32)

Get a specific langauge version of the reply template. No parsing is performed.

Declaration

public ReplyTemplateParsed GetUnparsedTemplate(int replyTemplateId, int languageId)

Parameters

Type	Name	Description
Int32	replyTemplateId	The id of the reply template
Int32	languageId	The language id (prefered language). If 0 is given, the language of the person will be used

Returns

Type	Description
ReplyTemplateParsed	The unparsed reply template, but using the same return data structure

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

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

HasChatNotify()

Check if user has any chat notification

Declaration

public bool HasChatNotify()

Returns

Type	Description
Boolean	True if the user has at least one notification setting on

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

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

RemoveSession(Int32)

Remove a login session for a CS user

Declaration

public void RemoveSession(int loginId)

Parameters

Type	Name	Description
Int32	loginId	The login id to remove

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

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

ReportSessionActive(String)

Report a session as being 'active'; will update the corresponding row in login table, but not more than once per minute/session

Declaration

public int ReportSessionActive(string sessionKey)

Parameters

Type	Name	Description
String	sessionKey	CS session key, matching the 'login' table

Returns

Type	Description
Int32	The ID of the login table row, or 0 if not found

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

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

SaveAllCustomerCenterConfigs(CustomerCenterConfig[])

Save an array of CustomerCenterConfig entities to the database

Declaration

public void SaveAllCustomerCenterConfigs(CustomerCenterConfig[] custConfigs)

Parameters

Type	Name	Description
CustomerCenterConfig[]	custConfigs	The CustomerCenterConfig entities to be saved. If the id does not exists, a new one will be created. Unknown ids will be skipped

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

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

SaveCustomerCenterConfig(CustomerCenterConfig)

Updates the existing CustomerCenterConfig or creates a new CustomerCenterConfig if the id parameter is empty

Declaration

public CustomerCenterConfig SaveCustomerCenterConfig(CustomerCenterConfig customerCenterConfig)

Parameters

Type	Name	Description
CustomerCenterConfig	customerCenterConfig	The CustomerCenterConfig that is saved.

Returns

Type	Description
CustomerCenterConfig	New or updated CustomerCenterConfig

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

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

SaveMailboxEntity(MailboxEntity)

Updates the existing MailboxEntity or creates a new MailboxEntity if the id parameter is empty

Declaration

public MailboxEntity SaveMailboxEntity(MailboxEntity mailboxEntity)

Parameters

Type	Name	Description
MailboxEntity	mailboxEntity	The MailboxEntity that is saved.

Returns

Type	Description
MailboxEntity	New or updated MailboxEntity

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

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

SaveSmsConfig(SmsConfig)

Updates the existing SmsConfig or creates a new SmsConfig if the id parameter is empty

Declaration

public SmsConfig SaveSmsConfig(SmsConfig smsConfig)

Parameters

Type	Name	Description
SmsConfig	smsConfig	The SmsConfig that is saved.

Returns

Type	Description
SmsConfig	New or updated SmsConfig

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

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

SaveSystemTemplateSettings(SystemTemplateSettings)

Saves and validates updated system templates. Throws exception if validation fails

Declaration

public SystemTemplateSettings SaveSystemTemplateSettings(SystemTemplateSettings systemTemplateSettings)

Parameters

Type	Name	Description
SystemTemplateSettings	systemTemplateSettings	System template settings item with updated values

Returns

Type	Description
SystemTemplateSettings	Updated system template settings

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

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

SessionIsValid(String)

Check if a CS session is valid

Declaration

public bool SessionIsValid(string csSessionKey)

Parameters

Type	Name	Description
String	csSessionKey	The CS session key to check

Returns

Type	Description
Boolean	True if there is a valid CS session based on the session key

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

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

TestSmtpServer(String, String, Boolean)

This method will do a test of a SMTP account, by sending an email to a special @superoffice.com account

Declaration

public SmtpTestResult TestSmtpServer(string smtpUri, string from, bool useStoredPassword)

Parameters

Type	Name	Description
String	smtpUri	An URI containing information to connect to the SMTP server, eg. smtps://myuser:mypassword@smtp.myserver.com:465. Note that username and password must be url encoded
String	from	The from-address used in the test
Boolean	useStoredPassword	Use database persisted password

Returns

Type	Description
SmtpTestResult	Contains the result of the test

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

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

UpdateFeatureToggles(CsFeatureToggle[])

Update the cached FeatureToggles for CS

Declaration

public void UpdateFeatureToggles(CsFeatureToggle[] featureToggles)

Parameters

Type	Name	Description
CsFeatureToggle[]	featureToggles	Feature toggle name / state

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

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

Implements

System.IDisposable

ICustomerServiceAgent

IAgent