DocAPI.v1.HeadInfo
hidden class DocAPI.v1.HeadInfo extends %Library.RegisteredObject
Property Inventory
- ALGLines
- CanonicalLines
- GTMCode
- JQuery
- Locale
- MetaInfo
- MoreMetaInfo
- OneTrust
- RobotLines
- STLines
- SearchScript
- ServerIDLine
- StylesheetLines
- TitleInfo
Method Inventory
- GetConfigInfo()
- GetHeadInfoForAlgoliaResultsPage()
- GetHeadInfoForKey()
- GetHeadInfoNEW()
- GetHeadInfoNoIndexNoFollow()
- GetMoreMetaInfoForOnlineUseNEW()
- GetPageTitleForALL()
- GetPageTitleForHomePage()
- GetPageTitleForKey()
- GetSearchScript()
Parameters
parameter METADESCMAX = 160;
This is the maximum number of characters that Google displays for meta text
Properties
property ALGLines as %String;
Meta tag lines added for Algolia search
Property methods: ALGLinesDisplayToLogical(), ALGLinesGet(), ALGLinesIsValid(), ALGLinesLogicalToDisplay(), ALGLinesLogicalToOdbc(), ALGLinesNormalize(), ALGLinesSet()
property CanonicalLines as %String;
Property methods: CanonicalLinesDisplayToLogical(), CanonicalLinesGet(), CanonicalLinesIsValid(), CanonicalLinesLogicalToDisplay(), CanonicalLinesLogicalToOdbc(), CanonicalLinesNormalize(), CanonicalLinesSet()
property GTMCode as %String;
Property methods: GTMCodeDisplayToLogical(), GTMCodeGet(), GTMCodeIsValid(), GTMCodeLogicalToDisplay(), GTMCodeLogicalToOdbc(), GTMCodeNormalize(), GTMCodeSet()
property JQuery as %String;
Property methods: JQueryDisplayToLogical(), JQueryGet(), JQueryIsValid(), JQueryLogicalToDisplay(), JQueryLogicalToOdbc(), JQueryNormalize(), JQuerySet()
property Locale as %String [ InitialExpression = "en-us" ];
Property methods: LocaleDisplayToLogical(), LocaleGet(), LocaleIsValid(), LocaleLogicalToDisplay(), LocaleLogicalToOdbc(), LocaleNormalize(), LocaleSet()
property MetaInfo as %String;
Property methods: MetaInfoDisplayToLogical(), MetaInfoGet(), MetaInfoIsValid(), MetaInfoLogicalToDisplay(), MetaInfoLogicalToOdbc(), MetaInfoNormalize(), MetaInfoSet()
property MoreMetaInfo as %String;
Property methods: MoreMetaInfoDisplayToLogical(), MoreMetaInfoGet(), MoreMetaInfoIsValid(), MoreMetaInfoLogicalToDisplay(), MoreMetaInfoLogicalToOdbc(), MoreMetaInfoNormalize(), MoreMetaInfoSet()
property OneTrust as %String;
Property methods: OneTrustDisplayToLogical(), OneTrustGet(), OneTrustIsValid(), OneTrustLogicalToDisplay(), OneTrustLogicalToOdbc(), OneTrustNormalize(), OneTrustSet()
property RobotLines as %String;
Property methods: RobotLinesDisplayToLogical(), RobotLinesGet(), RobotLinesIsValid(), RobotLinesLogicalToDisplay(), RobotLinesLogicalToOdbc(), RobotLinesNormalize(), RobotLinesSet()
property STLines as %String;
Property methods: STLinesDisplayToLogical(), STLinesGet(), STLinesIsValid(), STLinesLogicalToDisplay(), STLinesLogicalToOdbc(), STLinesNormalize(), STLinesSet()
property SearchScript as %String;
Property methods: SearchScriptDisplayToLogical(), SearchScriptGet(), SearchScriptIsValid(), SearchScriptLogicalToDisplay(), SearchScriptLogicalToOdbc(), SearchScriptNormalize(), SearchScriptSet()
property ServerIDLine as %String;
Property methods: ServerIDLineDisplayToLogical(), ServerIDLineGet(), ServerIDLineIsValid(), ServerIDLineLogicalToDisplay(), ServerIDLineLogicalToOdbc(), ServerIDLineNormalize(), ServerIDLineSet()
property StylesheetLines as %String;
Property methods: StylesheetLinesDisplayToLogical(), StylesheetLinesGet(), StylesheetLinesIsValid(), StylesheetLinesLogicalToDisplay(), StylesheetLinesLogicalToOdbc(), StylesheetLinesNormalize(), StylesheetLinesSet()
property TitleInfo as %String;
Property methods: TitleInfoDisplayToLogical(), TitleInfoGet(), TitleInfoIsValid(), TitleInfoLogicalToDisplay(), TitleInfoLogicalToOdbc(), TitleInfoNormalize(), TitleInfoSet()
Methods
classmethod GetConfigInfo() as %String
classmethod GetHeadInfoForAlgoliaResultsPage(pagetitle As %String = "", description As %String = "", websitegroup As %String = "", includeMainStyles As %Boolean = 1, includeFacetFilters As %Boolean = 1)
classmethod GetHeadInfoForKey(DocBookID As %String = "", ByRef pagetitle, ByRef description) as DocAPI.v1.HeadInfo
classmethod GetHeadInfoNEW(pagetitle As %String = "", description As %String = "", websitegroup As %String = "", includeMainStyles As %Boolean = 1) as DocAPI.v1.HeadInfo
We set the includeMainStyles argument to 0 when we want the
headinfo object for a Zen page; such a page has its own CSS includes.
If description is null, we use pagetitle as the description.
classmethod GetHeadInfoNoIndexNoFollow(pagetitle As %String = "", description As %String = "", websitegroup As %String = "", includeMainStyles As %Boolean = 1, canonicalURL As %String = "") as DocAPI.v1.HeadInfo
Used by Doc.Error, Doc.Feedback, Doc.Search, Doc.Thanks, old Zen home page,
Publish.Index, and several Website.* classes.
classmethod GetMoreMetaInfoForOnlineUseNEW(pagetitle, description) as %String
classmethod GetPageTitleForALL(ByRef description) as %String
classmethod GetPageTitleForHomePage(description) as %String
classmethod GetSearchScript() as %String
Inherited Members
Inherited Methods
- %AddToSaveSet()
- %ClassIsLatestVersion()
- %ClassName()
- %ConstructClone()
- %DispatchClassMethod()
- %DispatchGetModified()
- %DispatchGetProperty()
- %DispatchMethod()
- %DispatchSetModified()
- %DispatchSetMultidimProperty()
- %DispatchSetProperty()
- %Extends()
- %GetParameter()
- %IsA()
- %IsModified()
- %New()
- %NormalizeObject()
- %ObjectModified()
- %OriginalNamespace()
- %PackageName()
- %RemoveFromSaveSet()
- %SerializeObject()
- %SetModified()
- %ValidateObject()