C# Class SobekCM.Core.Client.SobekEngineClient_AggregationEndpoints

Gateway to all the aggregation-related endpoints exposed by the SobekCM engine
Inheritance: MicroservicesClientBase
Datei anzeigen Open project: MarkVSullivan/SobekCM-Web-Application Class Usage Examples

Public Methods

Method Description
Add_New_Aggregation ( SobekCM.Core.Aggregations.New_Aggregation_Arguments NewAggregation ) : SobekCM.Core.Message.RestResponseMessage

Add a new aggregation to the system

Get_Aggregation ( string AggregationCode, Web_Language_Enum RequestedLanguage, Web_Language_Enum DefaultLanguage, Custom_Tracer Tracer ) : Item_Aggregation

Gets the language-specific item aggregation, by aggregation code and language code

Get_Aggregation_HTML_Child_Page ( string AggregationCode, Web_Language_Enum RequestedLanguage, Web_Language_Enum DefaultLanguage, string ChildPageCode, Custom_Tracer Tracer ) : HTML_Based_Content

Gets the all information, including the HTML, for an item aggregation child page

Get_Aggregation_Hierarchy ( Custom_Tracer Tracer ) : SobekCM.Core.Aggregations.Aggregation_Hierarchy

Gets the entire collection hierarchy (used for hierarchical tree displays)

Get_Complete_Aggregation ( string AggregationCode, bool UseCache, Custom_Tracer Tracer ) : Complete_Item_Aggregation

Gets the complete (language agnostic) item aggregation, by aggregation code

SobekEngineClient_AggregationEndpoints ( MicroservicesClient_Configuration ConfigObj ) : SobekCM.Core.Aggregations

Constructor for a new instance of the SobekEngineClient_AggregationEndpoints class

Method Details

Add_New_Aggregation() public method

Add a new aggregation to the system
public Add_New_Aggregation ( SobekCM.Core.Aggregations.New_Aggregation_Arguments NewAggregation ) : SobekCM.Core.Message.RestResponseMessage
NewAggregation SobekCM.Core.Aggregations.New_Aggregation_Arguments Information for the new aggregation
return SobekCM.Core.Message.RestResponseMessage

Get_Aggregation() public method

Gets the language-specific item aggregation, by aggregation code and language code
public Get_Aggregation ( string AggregationCode, Web_Language_Enum RequestedLanguage, Web_Language_Enum DefaultLanguage, Custom_Tracer Tracer ) : Item_Aggregation
AggregationCode string Code for the aggregation
RequestedLanguage Web_Language_Enum Requested language to retrieve
DefaultLanguage Web_Language_Enum Default interface language, in case the requested language does not exist
Tracer SobekCM.Tools.Custom_Tracer Trace object keeps a list of each method executed and important milestones in rendering
return SobekCM.Core.Aggregations.Item_Aggregation

Get_Aggregation_HTML_Child_Page() public method

Gets the all information, including the HTML, for an item aggregation child page
public Get_Aggregation_HTML_Child_Page ( string AggregationCode, Web_Language_Enum RequestedLanguage, Web_Language_Enum DefaultLanguage, string ChildPageCode, Custom_Tracer Tracer ) : HTML_Based_Content
AggregationCode string Code for the aggregation
RequestedLanguage Web_Language_Enum Requested language to retrieve
DefaultLanguage Web_Language_Enum Default interface language, in case the requested language does not exist
ChildPageCode string Code the requested child page
Tracer SobekCM.Tools.Custom_Tracer Trace object keeps a list of each method executed and important milestones in rendering
return SobekCM.Core.WebContent.HTML_Based_Content

Get_Aggregation_Hierarchy() public method

Gets the entire collection hierarchy (used for hierarchical tree displays)
public Get_Aggregation_Hierarchy ( Custom_Tracer Tracer ) : SobekCM.Core.Aggregations.Aggregation_Hierarchy
Tracer SobekCM.Tools.Custom_Tracer Trace object keeps a list of each method executed and important milestones in rendering
return SobekCM.Core.Aggregations.Aggregation_Hierarchy

Get_Complete_Aggregation() public method

Gets the complete (language agnostic) item aggregation, by aggregation code
public Get_Complete_Aggregation ( string AggregationCode, bool UseCache, Custom_Tracer Tracer ) : Complete_Item_Aggregation
AggregationCode string Code for the requested aggregation
UseCache bool Flag indicates if the cache should be used to check for a built copy or store the final product
Tracer SobekCM.Tools.Custom_Tracer Trace object keeps a list of each method executed and important milestones in rendering
return SobekCM.Core.Aggregations.Complete_Item_Aggregation

SobekEngineClient_AggregationEndpoints() public method

Constructor for a new instance of the SobekEngineClient_AggregationEndpoints class
public SobekEngineClient_AggregationEndpoints ( MicroservicesClient_Configuration ConfigObj ) : SobekCM.Core.Aggregations
ConfigObj SobekCM.Core.MicroservicesClient.MicroservicesClient_Configuration Fully constructed microservices client configuration
return SobekCM.Core.Aggregations