Class CustomerService
Inheritance
CustomerService
Assembly: SoDataBase.dll
Syntax
public static class CustomerService
Fields
Declaration
public const int ListItemIdForMailingsTypeDocument = 3
Field Value
Declaration
public const int ListItemIdForMailingsTypeHtml = 1
Field Value
Declaration
public const int ListItemIdForMailingsTypeSms = 2
Field Value
MailingsTypeForDocument
Declaration
public const string MailingsTypeForDocument = "doc"
Field Value
MailingsTypeForHtml
Declaration
public const string MailingsTypeForHtml = "html"
Field Value
MailingsTypeForSms
Declaration
public const string MailingsTypeForSms = "sms"
Field Value
Methods
GetBaseUrl()
Declaration
public static string GetBaseUrl()
Returns
GetBaseUrl(string, CsUrlType)
Declaration
public static string GetBaseUrl(string program, CustomerService.CsUrlType urlType = CsUrlType.Internal)
Parameters
Returns
GetCSAuthUrl(string, string, string, string)
Declaration
public static string GetCSAuthUrl(string program, string action, string language, string extraParameters)
Parameters
Returns
GetCSRegistryValueAsync(int, CancellationToken)
Declaration
public static Task<string> GetCSRegistryValueAsync(int entryId, CancellationToken cancellationToken = default)
Parameters
Returns
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
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
Returns
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
GetOpenMailingsUrl(string, int)
Declaration
public static string GetOpenMailingsUrl(string languageCode, int shipmentId)
Parameters
Type |
Name |
Description |
string |
languageCode |
|
int |
shipmentId |
|
Returns
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
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
GetSubscriptionManagementUrlAsync(int, string, CancellationToken)
Declaration
public static Task<string> GetSubscriptionManagementUrlAsync(int personId, string languageCode, CancellationToken cancellationToken = default)
Parameters
Returns
GetSubscriptionManagementUrlAsync(int, CancellationToken)
Declaration
public static Task<string> GetSubscriptionManagementUrlAsync(int personId, CancellationToken cancellationToken = default)
Parameters
Returns
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