C# Class SobekCM.Core.Client.SobekEngineClient_WebContentEndpoints

Gateway to all the web content-related endpoints exposed by the SobekCM engine

Inheritance: MicroservicesClientBase

ファイルを表示 Open project: MarkVSullivan/SobekCM-Web-Application Class Usage Examples

Public Methods

Method	Description
Add_HTML_Based_Content ( HTML_Based_Content Content, string User, bool InheritFromAnyParent, Custom_Tracer Tracer ) : SobekCM.Core.Message.RestResponseMessage	Add a new web content page or redirect
Add_Milestone ( int WebContentID, string User, string Milestone, Custom_Tracer Tracer ) : SobekCM.Core.Message.RestResponseMessage	Add a milestone to an existing web content page
Clear_Special_Missing_Page ( Custom_Tracer Tracer ) : void	Gets the special missing web content page, used when a requested resource is missing
Delete_HTML_Based_Content ( int WebContentID, string User, string Reason, Custom_Tracer Tracer ) : SobekCM.Core.Message.RestResponseMessage	Delete a web content page
Get_All ( Custom_Tracer Tracer, int Page, int RowsPerPage = null ) : SobekCM.Core.WebContent.Admin.WebContent_Basic_Pages	Get the list of all the web content entities, including pages and redirects
Get_All_Controlled_Javascript ( Custom_Tracer Tracer ) : List	Get the list of all controlled javascript files from the engine endpoint
Get_All_Controlled_Stylesheets ( Custom_Tracer Tracer ) : List	Get the list of all controlled CSS stylesheet files from the engine endpoint
Get_All_NextLevel ( Custom_Tracer Tracer, string Level1 = null, string Level2 = null, string Level3 = null, string Level4 = null, string Level5 = null, string Level6 = null, string Level7 = null, string Level8 = null ) : List	Gets the list of possible next level from an existing point in the page AND redirects hierarchy, used for filtering
Get_All_Pages ( Custom_Tracer Tracer, int Page, int RowsPerPage = null ) : SobekCM.Core.WebContent.Admin.WebContent_Basic_Pages	Get the list of all the web content pages ( excluding redirects )
Get_All_Pages_NextLevel ( Custom_Tracer Tracer, string Level1 = null, string Level2 = null, string Level3 = null, string Level4 = null, string Level5 = null, string Level6 = null, string Level7 = null, string Level8 = null ) : List	Gets the list of possible next level from an existing point in the page hierarchy, used for filtering
Get_All_Redirects ( Custom_Tracer Tracer, int Page, int RowsPerPage = null ) : SobekCM.Core.WebContent.Admin.WebContent_Basic_Pages	Get the list of all the global redirects
Get_All_Redirects_NextLevel ( Custom_Tracer Tracer, string Level1 = null, string Level2 = null, string Level3 = null, string Level4 = null, string Level5 = null, string Level6 = null, string Level7 = null, string Level8 = null ) : List	Gets the list of possible next level from an existing point in the redirects hierarchy, used for filtering
Get_All_Sitemaps ( Custom_Tracer Tracer ) : List	Get the list of all sitemaps from the engine endpoint
Get_Global_Recent_Updates ( Custom_Tracer Tracer, int Page, int RowsPerPage = null, string UserFilter = null ) : WebContent_Recent_Changes	Get the list of all the recent updates to all (non aggregation affiliated) static web content pages
Get_Global_Recent_Updates_NextLevel ( Custom_Tracer Tracer, string Level1 = null, string Level2 = null, string Level3 = null, string Level4 = null, string Level5 = null, string Level6 = null, string Level7 = null, string Level8 = null ) : List	Gets the list of possible next level from an existing page in the recent updates, used for filtering
Get_Global_Recent_Updates_Users ( Custom_Tracer Tracer ) : List	Get the list of all users that have participated in the recent updates to all top-level static web content pages
Get_Global_Usage_Report ( Custom_Tracer Tracer, int Year1, int Month1, int Year2, int Month2, int Page, int RowsPerPage = null ) : WebContent_Usage_Report	Get usage of all web content pages between two dates
Get_Global_Usage_Report_NextLevel ( Custom_Tracer Tracer, int Year1, int Month1, int Year2, int Month2, string Level1 = null, string Level2 = null, string Level3 = null, string Level4 = null, string Level5 = null, string Level6 = null, string Level7 = null, string Level8 = null ) : List	Gets the list of possible next level from an existing used page in a global usage report, used for filtering
Get_HTML_Based_Content ( int WebContentID, bool UseCache, Custom_Tracer Tracer ) : HTML_Based_Content	Get the information for a single non-aggregational web content page
Get_HTML_Based_Content ( string InfoBrowseMode, Custom_Tracer Tracer ) : HTML_Based_Content	Get the information for a single top-level web content page
Get_Hierarchy ( bool UseCache, Custom_Tracer Tracer ) : WebContent_Hierarchy	Get the complete hierarchy of web content pages and redirects, used for navigation
Get_Single_Milestones ( int WebContentID, Custom_Tracer Tracer ) : Single_WebContent_Change_Report	Get the list of milestones affecting a single (non aggregation affiliated) static web content page
Get_Single_Usage_Report ( int WebContentID, Custom_Tracer Tracer ) : Single_WebContent_Usage_Report	Get the complete monthly usage for a single web content page
Get_Special_Missing_Page ( Custom_Tracer Tracer ) : HTML_Based_Content	Gets the special missing web content page, used when a requested resource is missing
Has_Content_Pages ( Custom_Tracer Tracer ) : bool	Returns a flag indicating if there are any web content pages (excluding redirects)
Has_Global_Recent_Updates ( Custom_Tracer Tracer ) : bool	Returns a flag indicating if there are any global recent updates to the web content entities (pages and redirects)
Has_Global_Usage ( Custom_Tracer Tracer ) : bool	Returns a flag indicating if any usage has been reported for this instance's web content entities (pages and redirects)
Has_Pages_Or_Redirects ( Custom_Tracer Tracer ) : bool	Returns a flag indicating if there are any web content entities, including pages and redirects
Has_Redirects ( Custom_Tracer Tracer ) : bool	Returns a flag indicating if there are any global redirects within the web content system
SobekEngineClient_WebContentEndpoints ( MicroservicesClient_Configuration ConfigObj ) : System	Constructor for a new instance of the SobekEngineClient_WebContentEndpoints class
Update_HTML_Based_Content ( HTML_Based_Content Content, string User, Custom_Tracer Tracer ) : RestResponseMessage	Update an existing web content page or redirect

Method Details

Add_HTML_Based_Content() public method

Add a new web content page or redirect

public Add_HTML_Based_Content ( HTML_Based_Content Content, string User, bool InheritFromAnyParent, Custom_Tracer Tracer ) : SobekCM.Core.Message.RestResponseMessage
Content	SobekCM.Core.WebContent.HTML_Based_Content	Newly updated HTML content to be put back on the server
User	string	Name of the user that performed the work
InheritFromAnyParent	bool	Flag indicates if this should inherit some design attributes from any found parent
Tracer	SobekCM.Tools.Custom_Tracer
return	SobekCM.Core.Message.RestResponseMessage

Add_Milestone() public method

Add a milestone to an existing web content page

public Add_Milestone ( int WebContentID, string User, string Milestone, Custom_Tracer Tracer ) : SobekCM.Core.Message.RestResponseMessage
WebContentID	int	Primary key for the web content page or redirect to add milestone to
User	string	Name of the user that performed the work
Milestone	string	Notes associated with this milestone
Tracer	SobekCM.Tools.Custom_Tracer
return	SobekCM.Core.Message.RestResponseMessage

Clear_Special_Missing_Page() public method

Gets the special missing web content page, used when a requested resource is missing

public Clear_Special_Missing_Page ( Custom_Tracer Tracer ) : void
Tracer	SobekCM.Tools.Custom_Tracer
return	void

Delete_HTML_Based_Content() public method

Delete a web content page

public Delete_HTML_Based_Content ( int WebContentID, string User, string Reason, Custom_Tracer Tracer ) : SobekCM.Core.Message.RestResponseMessage
WebContentID	int	Primary key for the web content page or redirect to delete
User	string	Name of the user that performed the work
Reason	string
Tracer	SobekCM.Tools.Custom_Tracer
return	SobekCM.Core.Message.RestResponseMessage

Get_All() public method

Get the list of all the web content entities, including pages and redirects

public Get_All ( Custom_Tracer Tracer, int Page, int RowsPerPage = null ) : SobekCM.Core.WebContent.Admin.WebContent_Basic_Pages
Tracer	SobekCM.Tools.Custom_Tracer	Trace object keeps a list of each method executed and important milestones in rendering
Page	int	Page number of used pages ( starting with one and counting up )
RowsPerPage	int	(Optional) Number of rows of used pages to include in each page of results
return	SobekCM.Core.WebContent.Admin.WebContent_Basic_Pages

Get_All_Controlled_Javascript() public method

Get the list of all controlled javascript files from the engine endpoint

public Get_All_Controlled_Javascript ( Custom_Tracer Tracer ) : List
Tracer	SobekCM.Tools.Custom_Tracer
return	List

Get_All_Controlled_Stylesheets() public method

Get the list of all controlled CSS stylesheet files from the engine endpoint

public Get_All_Controlled_Stylesheets ( Custom_Tracer Tracer ) : List
Tracer	SobekCM.Tools.Custom_Tracer
return	List

Get_All_NextLevel() public method

Gets the list of possible next level from an existing point in the page AND redirects hierarchy, used for filtering

public Get_All_NextLevel ( Custom_Tracer Tracer, string Level1 = null, string Level2 = null, string Level3 = null, string Level4 = null, string Level5 = null, string Level6 = null, string Level7 = null, string Level8 = null ) : List
Tracer	SobekCM.Tools.Custom_Tracer	Trace object keeps a list of each method executed and important milestones in rendering
Level1	string	(Optional) First level of URL for the updated web content entity, if looking for children of a page
Level2	string	(Optional) Second level of URL for the updated web content entity, if looking for children of a page
Level3	string	(Optional) Third level of URL for the updated web content entity, if looking for children of a page
Level4	string	(Optional) Fourth level of URL for the updated web content entity, if looking for children of a page
Level5	string	(Optional) Fifth level of URL for the updated web content entity, if looking for children of a page
Level6	string	(Optional) Sixth level of URL for the updated web content entity, if looking for children of a page
Level7	string	(Optional) Seventh level of URL for the updated web content entity, if looking for children of a page
Level8	string	(Optional) Eighth level of URL for the updated web content entity, if looking for children of a page
return	List

Get_All_Pages() public method

Get the list of all the web content pages ( excluding redirects )

public Get_All_Pages ( Custom_Tracer Tracer, int Page, int RowsPerPage = null ) : SobekCM.Core.WebContent.Admin.WebContent_Basic_Pages
Tracer	SobekCM.Tools.Custom_Tracer	Trace object keeps a list of each method executed and important milestones in rendering
Page	int	Page number of used pages ( starting with one and counting up )
RowsPerPage	int	(Optional) Number of rows of used pages to include in each page of results
return	SobekCM.Core.WebContent.Admin.WebContent_Basic_Pages

Get_All_Pages_NextLevel() public method

Gets the list of possible next level from an existing point in the page hierarchy, used for filtering

public Get_All_Pages_NextLevel ( Custom_Tracer Tracer, string Level1 = null, string Level2 = null, string Level3 = null, string Level4 = null, string Level5 = null, string Level6 = null, string Level7 = null, string Level8 = null ) : List
Tracer	SobekCM.Tools.Custom_Tracer	Trace object keeps a list of each method executed and important milestones in rendering
Level1	string	(Optional) First level of URL for the updated web content entity, if looking for children of a page
Level2	string	(Optional) Second level of URL for the updated web content entity, if looking for children of a page
Level3	string	(Optional) Third level of URL for the updated web content entity, if looking for children of a page
Level4	string	(Optional) Fourth level of URL for the updated web content entity, if looking for children of a page
Level5	string	(Optional) Fifth level of URL for the updated web content entity, if looking for children of a page
Level6	string	(Optional) Sixth level of URL for the updated web content entity, if looking for children of a page
Level7	string	(Optional) Seventh level of URL for the updated web content entity, if looking for children of a page
Level8	string	(Optional) Eighth level of URL for the updated web content entity, if looking for children of a page
return	List

Get_All_Redirects() public method

Get the list of all the global redirects

public Get_All_Redirects ( Custom_Tracer Tracer, int Page, int RowsPerPage = null ) : SobekCM.Core.WebContent.Admin.WebContent_Basic_Pages
Tracer	SobekCM.Tools.Custom_Tracer	Trace object keeps a list of each method executed and important milestones in rendering
Page	int	Page number of used pages ( starting with one and counting up )
RowsPerPage	int	(Optional) Number of rows of used pages to include in each page of results
return	SobekCM.Core.WebContent.Admin.WebContent_Basic_Pages

Get_All_Redirects_NextLevel() public method

Gets the list of possible next level from an existing point in the redirects hierarchy, used for filtering

public Get_All_Redirects_NextLevel ( Custom_Tracer Tracer, string Level1 = null, string Level2 = null, string Level3 = null, string Level4 = null, string Level5 = null, string Level6 = null, string Level7 = null, string Level8 = null ) : List
Tracer	Custom_Tracer	Trace object keeps a list of each method executed and important milestones in rendering
Level1	string	(Optional) First level of URL for the updated web content entity, if looking for children of a page
Level2	string	(Optional) Second level of URL for the updated web content entity, if looking for children of a page
Level3	string	(Optional) Third level of URL for the updated web content entity, if looking for children of a page
Level4	string	(Optional) Fourth level of URL for the updated web content entity, if looking for children of a page
Level5	string	(Optional) Fifth level of URL for the updated web content entity, if looking for children of a page
Level6	string	(Optional) Sixth level of URL for the updated web content entity, if looking for children of a page
Level7	string	(Optional) Seventh level of URL for the updated web content entity, if looking for children of a page
Level8	string	(Optional) Eighth level of URL for the updated web content entity, if looking for children of a page
return	List

Get_All_Sitemaps() public method

Get the list of all sitemaps from the engine endpoint

public Get_All_Sitemaps ( Custom_Tracer Tracer ) : List
Tracer	Custom_Tracer
return	List

Get_Global_Recent_Updates() public method

Get the list of all the recent updates to all (non aggregation affiliated) static web content pages

public Get_Global_Recent_Updates ( Custom_Tracer Tracer, int Page, int RowsPerPage = null, string UserFilter = null ) : WebContent_Recent_Changes
Tracer	Custom_Tracer	Trace object keeps a list of each method executed and important milestones in rendering
Page	int	Page number of recent updates ( starting with one and counting up )
RowsPerPage	int	(Optional) Number of rows of updates to include in each page of results
UserFilter	string	(Optional) Filter to only return items updated by one user
return	WebContent_Recent_Changes

Get_Global_Recent_Updates_NextLevel() public method

Gets the list of possible next level from an existing page in the recent updates, used for filtering

public Get_Global_Recent_Updates_NextLevel ( Custom_Tracer Tracer, string Level1 = null, string Level2 = null, string Level3 = null, string Level4 = null, string Level5 = null, string Level6 = null, string Level7 = null, string Level8 = null ) : List
Tracer	Custom_Tracer	Trace object keeps a list of each method executed and important milestones in rendering
Level1	string	(Optional) First level of URL for the updated web content entity, if looking for children of a page
Level2	string	(Optional) Second level of URL for the updated web content entity, if looking for children of a page
Level3	string	(Optional) Third level of URL for the updated web content entity, if looking for children of a page
Level4	string	(Optional) Fourth level of URL for the updated web content entity, if looking for children of a page
Level5	string	(Optional) Fifth level of URL for the updated web content entity, if looking for children of a page
Level6	string	(Optional) Sixth level of URL for the updated web content entity, if looking for children of a page
Level7	string	(Optional) Seventh level of URL for the updated web content entity, if looking for children of a page
Level8	string	(Optional) Eighth level of URL for the updated web content entity, if looking for children of a page
return	List

Get_Global_Recent_Updates_Users() public method

Get the list of all users that have participated in the recent updates to all top-level static web content pages

public Get_Global_Recent_Updates_Users ( Custom_Tracer Tracer ) : List
Tracer	Custom_Tracer	Trace object keeps a list of each method executed and important milestones in rendering
return	List

Get_Global_Usage_Report() public method

Get usage of all web content pages between two dates

public Get_Global_Usage_Report ( Custom_Tracer Tracer, int Year1, int Month1, int Year2, int Month2, int Page, int RowsPerPage = null ) : WebContent_Usage_Report
Tracer	Custom_Tracer	Trace object keeps a list of each method executed and important milestones in rendering
Year1	int	Start year of the year/month range for these usage stats
Month1	int	Start month of the year/month range for these usage stats
Year2	int	End year of the year/month range for these usage stats
Month2	int	End month of the year/month range for these usage stats
Page	int	Page number of used pages ( starting with one and counting up )
RowsPerPage	int	(Optional) Number of rows of used pages to include in each page of results
return	WebContent_Usage_Report

Get_Global_Usage_Report_NextLevel() public method

Gets the list of possible next level from an existing used page in a global usage report, used for filtering

public Get_Global_Usage_Report_NextLevel ( Custom_Tracer Tracer, int Year1, int Month1, int Year2, int Month2, string Level1 = null, string Level2 = null, string Level3 = null, string Level4 = null, string Level5 = null, string Level6 = null, string Level7 = null, string Level8 = null ) : List
Tracer	Custom_Tracer	Trace object keeps a list of each method executed and important milestones in rendering
Year1	int	Start year of the year/month range for these usage stats
Month1	int	Start month of the year/month range for these usage stats
Year2	int	End year of the year/month range for these usage stats
Month2	int	End month of the year/month range for these usage stats
Level1	string	(Optional) First level of URL for the updated web content entity, if looking for children of a page
Level2	string	(Optional) Second level of URL for the updated web content entity, if looking for children of a page
Level3	string	(Optional) Third level of URL for the updated web content entity, if looking for children of a page
Level4	string	(Optional) Fourth level of URL for the updated web content entity, if looking for children of a page
Level5	string	(Optional) Fifth level of URL for the updated web content entity, if looking for children of a page
Level6	string	(Optional) Sixth level of URL for the updated web content entity, if looking for children of a page
Level7	string	(Optional) Seventh level of URL for the updated web content entity, if looking for children of a page
Level8	string	(Optional) Eighth level of URL for the updated web content entity, if looking for children of a page
return	List

Get_HTML_Based_Content() public method

Get the information for a single non-aggregational web content page

public Get_HTML_Based_Content ( int WebContentID, bool UseCache, Custom_Tracer Tracer ) : HTML_Based_Content
WebContentID	int	Primary key for this non-aggregational web content page
UseCache	bool	Flag indicates whether to use the cache for this request
Tracer	Custom_Tracer
return	HTML_Based_Content

Get_HTML_Based_Content() public method

Get the information for a single top-level web content page

public Get_HTML_Based_Content ( string InfoBrowseMode, Custom_Tracer Tracer ) : HTML_Based_Content
InfoBrowseMode	string	Path for the requested web content page ( i.e., software/download/.. )
Tracer	Custom_Tracer
return	HTML_Based_Content

Get_Hierarchy() public method

Get the complete hierarchy of web content pages and redirects, used for navigation

public Get_Hierarchy ( bool UseCache, Custom_Tracer Tracer ) : WebContent_Hierarchy
UseCache	bool	Flag indicates whether this should look in the cache and store in the cache
Tracer	Custom_Tracer
return	WebContent_Hierarchy

Get_Single_Milestones() public method

Get the list of milestones affecting a single (non aggregation affiliated) static web content page

public Get_Single_Milestones ( int WebContentID, Custom_Tracer Tracer ) : Single_WebContent_Change_Report
WebContentID	int	Primary key to the web page in question
Tracer	Custom_Tracer
return	Single_WebContent_Change_Report

Get_Single_Usage_Report() public method

Get the complete monthly usage for a single web content page

public Get_Single_Usage_Report ( int WebContentID, Custom_Tracer Tracer ) : Single_WebContent_Usage_Report
WebContentID	int	Primary key of the web content page for which this the usage report applies
Tracer	Custom_Tracer
return	Single_WebContent_Usage_Report

Get_Special_Missing_Page() public method

Gets the special missing web content page, used when a requested resource is missing

public Get_Special_Missing_Page ( Custom_Tracer Tracer ) : HTML_Based_Content
Tracer	Custom_Tracer
return	HTML_Based_Content

Has_Content_Pages() public method

Returns a flag indicating if there are any web content pages (excluding redirects)

public Has_Content_Pages ( Custom_Tracer Tracer ) : bool
Tracer	Custom_Tracer	Trace object keeps a list of each method executed and important milestones in rendering
return	bool

Has_Global_Recent_Updates() public method

Returns a flag indicating if there are any global recent updates to the web content entities (pages and redirects)

public Has_Global_Recent_Updates ( Custom_Tracer Tracer ) : bool
Tracer	Custom_Tracer	Trace object keeps a list of each method executed and important milestones in rendering
return	bool

Has_Global_Usage() public method

Returns a flag indicating if any usage has been reported for this instance's web content entities (pages and redirects)

public Has_Global_Usage ( Custom_Tracer Tracer ) : bool
Tracer	Custom_Tracer	Trace object keeps a list of each method executed and important milestones in rendering
return	bool

Has_Pages_Or_Redirects() public method

Returns a flag indicating if there are any web content entities, including pages and redirects

public Has_Pages_Or_Redirects ( Custom_Tracer Tracer ) : bool
Tracer	Custom_Tracer	Trace object keeps a list of each method executed and important milestones in rendering
return	bool

Has_Redirects() public method

Returns a flag indicating if there are any global redirects within the web content system

public Has_Redirects ( Custom_Tracer Tracer ) : bool
Tracer	Custom_Tracer	Trace object keeps a list of each method executed and important milestones in rendering
return	bool

SobekEngineClient_WebContentEndpoints() public method

Constructor for a new instance of the SobekEngineClient_WebContentEndpoints class

public SobekEngineClient_WebContentEndpoints ( MicroservicesClient_Configuration ConfigObj ) : System
ConfigObj	MicroservicesClient_Configuration	Fully constructed microservices client configuration
return	System

Update_HTML_Based_Content() public method

Update an existing web content page or redirect

public Update_HTML_Based_Content ( HTML_Based_Content Content, string User, Custom_Tracer Tracer ) : RestResponseMessage
Content	HTML_Based_Content	Newly updated HTML content to be put back on the server
User	string	Name of the user that performed the work
Tracer	Custom_Tracer
return	RestResponseMessage