Doc.View
class Doc.View extends %CSP.Page
Method Inventory
- GetCardHTML()
- GetHTMLPageFromKey()
- GetInitialHTMLPage()
- GetMainHTMLForHomepage()
- GetMainHTMLForHomepageWithSections()
- OnPreHTTP()
- UpdateBadKeyGlobals()
- UpdateGoodKeyGlobals()
- UpdateSessionCountGlobals()
- UpdateSessionHelpGlobals()
Methods
Return the HTML for a card as displayed on the homepage for a product/version
classmethod GetHTMLPageFromKey(DocBookId As %String = "")
Given a DocBookId, return the HTML we can use to display the content,
including the HTML header.
If DocBookId includes "PAGE", then the is tagged with class="pagetopic".
classmethod GetInitialHTMLPage()
Return the HTML for the home page (as a string)
classmethod GetMainHTMLForHomepage(homeobj As %DynamicObject, cardarray As %DynamicArray)
Return the HTML to be placed inside the main tag on the homepage (in ..GetInitialHTMLPage())
classmethod GetMainHTMLForHomepageWithSections(homeobj As %DynamicObject, sectionarray As %DynamicArray)
Return the HTML to be placed inside the main tag on the homepage (in ..GetInitialHTMLPage())
with sections. This is only used when ^Settings("homepagetype") is set to "sections" -
this is configured through Relinfo (HomePageType) or ^docmaint.
See DOCS-7898
classmethod OnPreHTTP() as %Boolean
OnPreHTTP, determine whether we need to redirect based on DocAPI.v1.Redirects,
and do so if appropriate.
Otherwise, no change.
if we don't yet have data for this session + badkey, add that
if we don't yet have data for this session + key, add that
classmethod UpdateSessionCountGlobals(sessionid As %String = "")
if we don't yet have data for this session, add that
if we don't yet have data for this help-request key + session, add that.
This will let us see which content is accessed via the new help mechanism.
Inherited Members
Inherited Methods
- %ClassIsLatestVersion()
- %ClassName()
- %DispatchClassMethod()
- %DispatchGetModified()
- %DispatchGetProperty()
- %DispatchMethod()
- %DispatchSetModified()
- %DispatchSetMultidimProperty()
- %DispatchSetProperty()
- %Extends()
- %GetParameter()
- %IsA()
- %New()
- %OriginalNamespace()
- %PackageName()
- %SetModified()
- ConvertParameter()
- Decrypt()
- Encrypt()
- EscapeHTML()
- EscapeURL()
- HyperEventCall()
- HyperEventHead()
- Include()
- InsertHiddenField()
- InsertHiddenFields()
- IsPrivate()
- Link()
- OnHTTPHeader()
- OnPageError()
- OnPostHTTP()
- OnPostHyperEvent()
- OnPreHyperEvent()
- Page()
- QuoteJS()
- RewriteURL()
- ShowError()
- StartTimer()
- StopTimer()
- ThrowError()
- UnescapeHTML()
- UnescapeURL()