Method | Description | |
---|---|---|
Add_HTML_Based_Content ( |
Add a new web content page or redirect
|
|
Add_Milestone ( int WebContentID, string User, string Milestone, |
Add a milestone to an existing web content page
|
|
Clear_Special_Missing_Page ( |
Gets the special missing web content page, used when a requested resource is missing
|
|
Delete_HTML_Based_Content ( int WebContentID, string User, string Reason, |
Delete a web content page
|
|
Get_All ( |
Get the list of all the web content entities, including pages and redirects
|
|
Get_All_Controlled_Javascript ( |
Get the list of all controlled javascript files from the engine endpoint
|
|
Get_All_Controlled_Stylesheets ( |
Get the list of all controlled CSS stylesheet files from the engine endpoint
|
|
Get_All_NextLevel ( |
Gets the list of possible next level from an existing point in the page AND redirects hierarchy, used for filtering
|
|
Get_All_Pages ( |
Get the list of all the web content pages ( excluding redirects )
|
|
Get_All_Pages_NextLevel ( |
Gets the list of possible next level from an existing point in the page hierarchy, used for filtering
|
|
Get_All_Redirects ( |
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
|
public Add_HTML_Based_Content ( |
||
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 | ||
return | SobekCM.Core.Message.RestResponseMessage |
public Add_Milestone ( int WebContentID, string User, string Milestone, |
||
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 | ||
return | SobekCM.Core.Message.RestResponseMessage |
public Clear_Special_Missing_Page ( |
||
Tracer | ||
return | void |
public Delete_HTML_Based_Content ( int WebContentID, string User, string Reason, |
||
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 | ||
return | SobekCM.Core.Message.RestResponseMessage |
public Get_All ( |
||
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 |
public Get_All_Controlled_Javascript ( |
||
Tracer | ||
return | List |
public Get_All_Controlled_Stylesheets ( |
||
Tracer | ||
return | List |
public Get_All_NextLevel ( |
||
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 |
public Get_All_Pages ( |
||
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 |
public Get_All_Pages_NextLevel ( |
||
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 |
public Get_All_Redirects ( |
||
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 |
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 |
public Get_All_Sitemaps ( Custom_Tracer Tracer ) : List |
||
Tracer | Custom_Tracer | |
return | List |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
public Get_Special_Missing_Page ( Custom_Tracer Tracer ) : HTML_Based_Content | ||
Tracer | Custom_Tracer | |
return | HTML_Based_Content |
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 |
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 |
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 |
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 |
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 |
public SobekEngineClient_WebContentEndpoints ( MicroservicesClient_Configuration ConfigObj ) : System | ||
ConfigObj | MicroservicesClient_Configuration | Fully constructed microservices client configuration |
return | System |
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 |