C# Class SobekCM.Core.Client.SobekEngineClient_BuilderEndpoints

Gateway to all the builder-related endpoints exposed by the SobekCM engine
Inheritance: MicroservicesClientBase
ファイルを表示 Open project: MarkVSullivan/SobekCM-Web-Application Class Usage Examples

Public Methods

Method Description
Get_Builder_Folder ( int FolderID, Custom_Tracer Tracer ) : Builder_Source_Folder

Gets the information about a single builder incoming folder

Get_Builder_Settings ( bool IncludeDescriptions, Custom_Tracer Tracer ) : Builder_Settings

Get the builder-specific settings, including incoming folders and builder module sets

Get_Builder_Status ( Custom_Tracer Tracer ) : Builder_Status

Gets the latest update on the builder status, including the relevant builder setting values and updates on the scheduled tasks

SobekEngineClient_BuilderEndpoints ( MicroservicesClient_Configuration ConfigObj ) : System

Constructor for a new instance of the SobekEngineClient_BuilderEndpoints class

Method Details

Get_Builder_Folder() public method

Gets the information about a single builder incoming folder
public Get_Builder_Folder ( int FolderID, Custom_Tracer Tracer ) : Builder_Source_Folder
FolderID int Primary key for the incoming builder folder
Tracer SobekCM.Tools.Custom_Tracer
return Builder_Source_Folder

Get_Builder_Settings() public method

Get the builder-specific settings, including incoming folders and builder module sets
public Get_Builder_Settings ( bool IncludeDescriptions, Custom_Tracer Tracer ) : Builder_Settings
IncludeDescriptions bool Flag indicates if the builder module descriptions should be included in the response
Tracer SobekCM.Tools.Custom_Tracer
return SobekCM.Core.Settings.Builder_Settings

Get_Builder_Status() public method

Gets the latest update on the builder status, including the relevant builder setting values and updates on the scheduled tasks
public Get_Builder_Status ( Custom_Tracer Tracer ) : Builder_Status
Tracer SobekCM.Tools.Custom_Tracer
return SobekCM.Core.Builder.Builder_Status

SobekEngineClient_BuilderEndpoints() public method

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