mySobek Home   |   Help
Skip Navigation Links.
Expand <a href='http://sobekrepository.org/sobekcm' title='Sobek home page'>Project Home</a>Project Home
Expand <a href='http://sobekrepository.org/help' title='Online user help'>User Help</a>User Help
Expand <a href='http://sobekrepository.org/sobekcm/technical' title='Sobek home page'>Technical Help</a>Technical Help
Expand <a href='http://sobekrepository.org/software' title='Center for downloading all SobekCM-related software'>Download Center</a>Download Center
Training Videos
Collapse <a href='http://sobekrepository.org/codehelp' title='Details on each of the different classes, interfaces, properties, etc..'>Code Details</a>Code Details
MISSING BANNER
Code Details >> Core >> Client >> SobekEngineClient_WebContentEndpoints

SobekEngineClient_WebContentEndpoints Class



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


Namespace: SobekCM.Core.Client
Assembly: SobekCM_Engine_Library (in SobekCM_Engine_Library.dll) Version: 4.10.0.0 (4.10.0.0)

Syntax

C#
public class SobekEngineClient_WebContentEndpoints : MicroservicesClientBase

Inheritance Hierarchy

System..::..Object
  SobekCM.Core.MicroservicesClient..::..MicroservicesClientBase
    SobekCM.Core.Client..::..SobekEngineClient_WebContentEndpoints

Constructors

  NameDescription
Public methodSobekEngineClient_WebContentEndpoints
Constructor for a new instance of the SobekEngineClient_WebContentEndpoints class

Methods

  NameDescription
Public methodAdd_HTML_Based_Content
Add a new web content page or redirect
Public methodAdd_Milestone
Add a milestone to an existing web content page
Public methodDelete_HTML_Based_Content
Delete a web content page
Protected methodDeserialize<(Of <<'(T>)>>)(String, Microservice_Endpoint_Protocol_Enum, Custom_Tracer)
Deserialize an object from a remote microservice URI (Generic method)
(Inherited from MicroservicesClientBase.)
Protected methodDeserialize<(Of <<'(T>)>>)(String, Microservice_Endpoint_Protocol_Enum, List<(Of <<'(KeyValuePair<(Of <<'(String, String>)>>)>)>>), String, Custom_Tracer)
Deserialize an object from a remote microservice URI (Generic method)
(Inherited from MicroservicesClientBase.)
Public methodGet_All
Get the list of all the web content entities, including pages and redirects
Public methodGet_All_Controlled_Javascript
Get the list of all controlled javascript files from the engine endpoint
Public methodGet_All_Controlled_Stylesheets
Get the list of all controlled CSS stylesheet files from the engine endpoint
Public methodGet_All_NextLevel
Gets the list of possible next level from an existing point in the page AND redirects hierarchy, used for filtering
Public methodGet_All_Pages
Get the list of all the web content pages ( excluding redirects )
Public methodGet_All_Pages_NextLevel
Gets the list of possible next level from an existing point in the page hierarchy, used for filtering
Public methodGet_All_Redirects
Get the list of all the global redirects
Public methodGet_All_Redirects_NextLevel
Gets the list of possible next level from an existing point in the redirects hierarchy, used for filtering
Public methodGet_All_Sitemaps
Get the list of all sitemaps from the engine endpoint
Public methodGet_Global_Recent_Updates
Get the list of all the recent updates to all (non aggregation affiliated) static web content pages
Public methodGet_Global_Recent_Updates_NextLevel
Gets the list of possible next level from an existing page in the recent updates, used for filtering
Public methodGet_Global_Recent_Updates_Users
Get the list of all users that have participated in the recent updates to all top-level static web content pages
Public methodGet_Global_Usage_Report
Get usage of all web content pages between two dates
Public methodGet_Global_Usage_Report_NextLevel
Gets the list of possible next level from an existing used page in a global usage report, used for filtering
Public methodGet_Hierarchy
Get the complete hierarchy of web content pages and redirects, used for navigation
Public methodGet_HTML_Based_Content(String, Custom_Tracer)
Get the information for a single top-level web content page
Public methodGet_HTML_Based_Content(Int32, Boolean, Custom_Tracer)
Get the information for a single non-aggregational web content page
Public methodGet_Single_Milestones
Get the list of milestones affecting a single (non aggregation affiliated) static web content page
Public methodGet_Single_Usage_Report
Get the complete monthly usage for a single web content page
Public methodGet_Special_Missing_Page
Gets the special missing web content page, used when a requested resource is missing
Protected methodGetEndpointConfig
Gets the endpoint information from the microservices client configuration
(Inherited from MicroservicesClientBase.)
Public methodHas_Content_Pages
Returns a flag indicating if there are any web content pages (excluding redirects)
Public methodHas_Global_Recent_Updates
Returns a flag indicating if there are any global recent updates to the web content entities (pages and redirects)
Public methodHas_Global_Usage
Returns a flag indicating if any usage has been reported for this instance's web content entities (pages and redirects)
Public methodHas_Pages_Or_Redirects
Returns a flag indicating if there are any web content entities, including pages and redirects
Public methodHas_Redirects
Returns a flag indicating if there are any global redirects within the web content system
Public methodUpdate_HTML_Based_Content
Update an existing web content page or redirect

Properties

  NameDescription
Public propertyGet_All_JDataTable_URL
Get the URL for the list of all the web content entities, including pages and redirects, for consumption by the jQuery DataTable.net plug-in
Public propertyGet_All_Pages_JDataTable_URL
Get the URL for the list of all the web content pages ( excluding redirects ) for consumption by the jQuery DataTable.net plug-in
Public propertyGet_All_Redirects_JDataTable_URL
Get the URL for the list of all the global redirects for consumption by the jQuery DataTable.net plug-in
Public propertyGet_Global_Recent_Updates_JDataTable_URL
Get the URL for the list of all recent updates to (non aggregation affiliated) static web pages for consumption by the jQuery DataTable.net plug-in
Public propertyGet_Global_Usage_Report_JDataTable_URL
Get the URL for the list of usage for a global usage report for consumption by the jQuery DataTable.net plug-in
Public propertyUploaded_Files_URL
URL for the list of uploaded file JSON REST API

See Also



Version 4.10.0 ( last generated Monday, March 7, 2016 )