Show / Hide Table of Contents

Class CustomerService

Inheritance
Object
CustomerService
Inherited Members
Object.ToString()
Object.Equals(Object)
Object.Equals(Object, Object)
Object.ReferenceEquals(Object, Object)
Object.GetHashCode()
Object.GetType()
Object.MemberwiseClone()
Namespace: SuperOffice.CRM
Assembly: SoDataBase.dll
Syntax
public static class CustomerService

Fields

ListItemIdForMailingsTypeDocument

Declaration
public const int ListItemIdForMailingsTypeDocument = 3
Field Value
Type Description
Int32

ListItemIdForMailingsTypeHtml

Declaration
public const int ListItemIdForMailingsTypeHtml = 1
Field Value
Type Description
Int32

ListItemIdForMailingsTypeSms

Declaration
public const int ListItemIdForMailingsTypeSms = 2
Field Value
Type Description
Int32

MailingsTypeForDocument

Declaration
public const string MailingsTypeForDocument = "doc"
Field Value
Type Description
String

MailingsTypeForHtml

Declaration
public const string MailingsTypeForHtml = "html"
Field Value
Type Description
String

MailingsTypeForSms

Declaration
public const string MailingsTypeForSms = "sms"
Field Value
Type Description
String

Methods

GetBaseUrl()

Declaration
public static string GetBaseUrl()
Returns
Type Description
String

GetBaseUrl(String, CustomerService.CsUrlType)

Declaration
public static string GetBaseUrl(string program, CustomerService.CsUrlType urlType = CustomerService.CsUrlType.Internal)
Parameters
Type Name Description
String program
CustomerService.CsUrlType urlType
Returns
Type Description
String

GetCgiBin()

Facade method, executing corresponding plugin method.

Declaration
public static string GetCgiBin()
Returns
Type Description
String

URL (without hostname) to CS scripts folder

GetCgiUrlDirect()

Declaration
public static string GetCgiUrlDirect()
Returns
Type Description
String

GetCgiUrlExternal()

Facade method, executing corresponding plugin method.

Declaration
public static string GetCgiUrlExternal()
Returns
Type Description
String

External URL (hostname only) to CS

GetCgiUrlInternal()

Facade method, executing corresponding plugin method.

Declaration
public static string GetCgiUrlInternal()
Returns
Type Description
String

Internal URL (hostname only) to CS

GetCreateMailingsUrl(String, String, String)

Gets the Mailings URL for a given context.

Declaration
public static string GetCreateMailingsUrl(string languageCode, string mailingsType, string sourceContext)
Parameters
Type Name Description
String languageCode

The language code, 2 Chars SO code in which you want the CS program to run

String mailingsType

The mailings target type e.g. html, sms, document

String sourceContext

Reflects the context of the source e.g. "selectionId=123", "projectId=77"

Returns
Type Description
String

The complete string for the program in question with the parameters supplied

GetCSAuthUrl(String, String, String, String)

Declaration
public static string GetCSAuthUrl(string program, string action, string language, string extraParameters)
Parameters
Type Name Description
String program
String action
String language
String extraParameters
Returns
Type Description
String

GetCsProgramUrl(String, String, String, String, CsAuthenticationType, CustomerService.CsUrlType)

Gets the URL for a given Customer Service program.

Declaration
public static string GetCsProgramUrl(string program, string action, string language, string extraParameters, CsAuthenticationType authentication = CsAuthenticationType.None, CustomerService.CsUrlType urlType = CustomerService.CsUrlType.Internal)
Parameters
Type Name Description
String program

The program in question

String action

Defines an action parameter that usually defines which screen to open within the program.

String language

The language context in which you want the CS program to run

String extraParameters

A string consisting of one or more parameters in addition to the action parameter. These paramterers have different meaning depending on the action. These strings or name-value pairs should be separated by '&'

CsAuthenticationType authentication
CustomerService.CsUrlType urlType
Returns
Type Description
String

The complete string for the program in question with the parameters supplied

GetCSRegistryValue(Int32)

Declaration
public static string GetCSRegistryValue(int entryId)
Parameters
Type Name Description
Int32 entryId
Returns
Type Description
String

GetEditUrlFor(Int32)

Used by Win client. They don't want to know how it's build. It should be usable as is - for round-tripping.

Declaration
public static string GetEditUrlFor(int ticketId)
Parameters
Type Name Description
Int32 ticketId
Returns
Type Description
String

GetEMarketingUrl(String)

Used by Win/web client. They don't want to know how it's build. It should be usable as is - for round-tripping.

Declaration
public static string GetEMarketingUrl(string languageCode)
Parameters
Type Name Description
String languageCode
Returns
Type Description
String

GetOpenMailingsUrl(String, Int32)

Declaration
public static string GetOpenMailingsUrl(string languageCode, int shipmentId)
Parameters
Type Name Description
String languageCode
Int32 shipmentId
Returns
Type Description
String

GetPreviewUrlFor(Int32)

Used by Win client. They don't want to know how it's build. It should be usable as is - for round-tripping.

Declaration
public static string GetPreviewUrlFor(int ticketId)
Parameters
Type Name Description
Int32 ticketId
Returns
Type Description
String

GetRegistryExtension()

Facade method, executing corresponding plugin method.

Declaration
public static string GetRegistryExtension()
Returns
Type Description
String

Extension used in CS URLs

GetShowUrlFor(Int32)

Used by Win client. They don't want to know how it's build. It should be usable as is - for round-tripping.

Declaration
public static string GetShowUrlFor(int ticketId)
Parameters
Type Name Description
Int32 ticketId
Returns
Type Description
String

GetSubscriptionManagementUrl(Int32)

Declaration
public static string GetSubscriptionManagementUrl(int personId)
Parameters
Type Name Description
Int32 personId
Returns
Type Description
String

GetSubscriptionManagementUrl(Int32, String)

Declaration
public static string GetSubscriptionManagementUrl(int personId, string languageCode)
Parameters
Type Name Description
Int32 personId
String languageCode
Returns
Type Description
String

GetWwwFolder()

Facade method, executing corresponding plugin method.

Declaration
public static string GetWwwFolder()
Returns
Type Description
String

Www folder used in CS

MapShipmentStatusValue(Int16)

Declaration
public static string MapShipmentStatusValue(short statusValue)
Parameters
Type Name Description
Int16 statusValue
Returns
Type Description
String
© SuperOffice. All rights reserved.
SuperOffice |  Community |  Release Notes |  Privacy |  Site feedback |  Search Docs |  About Docs |  Contribute |  Back to top