C# Class SobekCM.Engine_Library.Endpoints.WebSkinServices

Class supports all the web skin-level services provided by the SobekCM engine
Inheritance: EndpointBase
Mostra file Open project: MarkVSullivan/SobekCM-Web-Application

Public Methods

Method Description
GetCompleteWebSkin ( HttpResponse Response, List UrlSegments, NameValueCollection QueryString, Microservice_Endpoint_Protocol_Enum Protocol, bool IsDebug ) : void

Gets the complete (language agnostic) web skin, by web skin code

GetOrderedCodes ( HttpResponse Response, List UrlSegments, NameValueCollection QueryString, Microservice_Endpoint_Protocol_Enum Protocol, bool IsDebug ) : void

Get the list of ordered web skin codes

GetWebSkin ( HttpResponse Response, List UrlSegments, NameValueCollection QueryString, Microservice_Endpoint_Protocol_Enum Protocol, bool IsDebug ) : void

Gets the language-specific web skin, by web skin code and language code

GetWebSkinUploadedImages ( HttpResponse Response, List UrlSegments, NameValueCollection QueryString, Microservice_Endpoint_Protocol_Enum Protocol, bool IsDebug ) : void

[PUBLIC] Get the list of uploaded images for a particular web skin

This REST API should be publicly available for users that are performing administrative work

get_complete_web_skin ( string SkinCode, Custom_Tracer Tracer ) : Complete_Web_Skin_Object

[HELPER] Gets the complete (language agnostic) web skin, by web skin code

This may be public now, but this will be converted into a private helped class with the release of SobekCM 5.0

get_web_skin ( string SkinCode, Web_Language_Enum RequestedLanguage, Web_Language_Enum DefaultLanguage, Custom_Tracer Tracer ) : Web_Skin_Object

[HELPER] Gets the language-specific web skin, by web skin code and language code

This may be public now, but this will be converted into a private helped class with the release of SobekCM 5.0

Method Details

GetCompleteWebSkin() public method

Gets the complete (language agnostic) web skin, by web skin code
public GetCompleteWebSkin ( HttpResponse Response, List UrlSegments, NameValueCollection QueryString, Microservice_Endpoint_Protocol_Enum Protocol, bool IsDebug ) : void
Response System.Web.HttpResponse
UrlSegments List
QueryString System.Collections.Specialized.NameValueCollection
Protocol Microservice_Endpoint_Protocol_Enum
IsDebug bool
return void

GetOrderedCodes() public method

Get the list of ordered web skin codes
public GetOrderedCodes ( HttpResponse Response, List UrlSegments, NameValueCollection QueryString, Microservice_Endpoint_Protocol_Enum Protocol, bool IsDebug ) : void
Response System.Web.HttpResponse
UrlSegments List
QueryString System.Collections.Specialized.NameValueCollection
Protocol Microservice_Endpoint_Protocol_Enum
IsDebug bool
return void

GetWebSkin() public method

Gets the language-specific web skin, by web skin code and language code
public GetWebSkin ( HttpResponse Response, List UrlSegments, NameValueCollection QueryString, Microservice_Endpoint_Protocol_Enum Protocol, bool IsDebug ) : void
Response System.Web.HttpResponse
UrlSegments List
QueryString System.Collections.Specialized.NameValueCollection
Protocol Microservice_Endpoint_Protocol_Enum
IsDebug bool
return void

GetWebSkinUploadedImages() public method

[PUBLIC] Get the list of uploaded images for a particular web skin
This REST API should be publicly available for users that are performing administrative work
public GetWebSkinUploadedImages ( HttpResponse Response, List UrlSegments, NameValueCollection QueryString, Microservice_Endpoint_Protocol_Enum Protocol, bool IsDebug ) : void
Response System.Web.HttpResponse
UrlSegments List
QueryString System.Collections.Specialized.NameValueCollection
Protocol Microservice_Endpoint_Protocol_Enum
IsDebug bool
return void

get_complete_web_skin() public static method

[HELPER] Gets the complete (language agnostic) web skin, by web skin code
This may be public now, but this will be converted into a private helped class with the release of SobekCM 5.0
public static get_complete_web_skin ( string SkinCode, Custom_Tracer Tracer ) : Complete_Web_Skin_Object
SkinCode string Web skin code
Tracer SobekCM.Tools.Custom_Tracer
return SobekCM.Core.Skins.Complete_Web_Skin_Object

get_web_skin() public static method

[HELPER] Gets the language-specific web skin, by web skin code and language code
This may be public now, but this will be converted into a private helped class with the release of SobekCM 5.0
public static get_web_skin ( string SkinCode, Web_Language_Enum RequestedLanguage, Web_Language_Enum DefaultLanguage, Custom_Tracer Tracer ) : Web_Skin_Object
SkinCode string Web skin code
RequestedLanguage Web_Language_Enum Web language
DefaultLanguage Web_Language_Enum Default language, in case the requested web language does nto exist
Tracer SobekCM.Tools.Custom_Tracer
return SobekCM.Core.Skins.Web_Skin_Object