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
int

ListItemIdForMailingsTypeHtml

Declaration

public const int ListItemIdForMailingsTypeHtml = 1

Field Value

Type	Description
int

ListItemIdForMailingsTypeSms

Declaration

public const int ListItemIdForMailingsTypeSms = 2

Field Value

Type	Description
int

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, CsUrlType)

Declaration

public static string GetBaseUrl(string program, CustomerService.CsUrlType urlType = CsUrlType.Internal)

Parameters

Type	Name	Description
string	program
CustomerService.CsUrlType	urlType

Returns

Type	Description
string

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

GetCSRegistryValueAsync(int, CancellationToken)

Declaration

public static Task<string> GetCSRegistryValueAsync(int entryId, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
int	entryId
CancellationToken	cancellationToken

Returns

Type	Description
Task<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

GetCsProgramUrl(string, string, string, string, CsAuthenticationType, 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 = 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

GetEMarketingUrlAsync(string, CancellationToken)

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 Task<string> GetEMarketingUrlAsync(string languageCode, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	languageCode
CancellationToken	cancellationToken

Returns

Type	Description
Task<string>

GetEditUrlFor(int)

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
int	ticketId

Returns

Type	Description
string

GetOpenMailingsUrl(string, int)

Declaration

public static string GetOpenMailingsUrl(string languageCode, int shipmentId)

Parameters

Type	Name	Description
string	languageCode
int	shipmentId

Returns

Type	Description
string

GetPreviewUrlFor(int)

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
int	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(int)

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
int	ticketId

Returns

Type	Description
string

GetSubscriptionManagementUrlAsync(int, string, CancellationToken)

Declaration

public static Task<string> GetSubscriptionManagementUrlAsync(int personId, string languageCode, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
int	personId
string	languageCode
CancellationToken	cancellationToken

Returns

Type	Description
Task<string>

GetSubscriptionManagementUrlAsync(int, CancellationToken)

Declaration

public static Task<string> GetSubscriptionManagementUrlAsync(int personId, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
int	personId
CancellationToken	cancellationToken

Returns

Type	Description
Task<string>

GetWwwFolder()

Facade method, executing corresponding plugin method.

Declaration

public static string GetWwwFolder()

Returns

Type	Description
string	Www folder used in CS

MapShipmentStatusValue(short)

Declaration

public static string MapShipmentStatusValue(short statusValue)

Parameters

Type	Name	Description
short	statusValue

Returns

Type	Description
string