VisitorMethods Class

Visitor methods - wrapping methods for macro resolver.

Inheritance Hierarchy

System.Object
  CMS.MacroEngine.MacroExtensionContainer<MacroMethodContainer, MacroMethod>
    CMS.MacroEngine.MacroMethodContainer
      CMS.WebAnalytics.VisitorMethods

Namespace: CMS.WebAnalytics
Assembly: CMS.WebAnalytics (in CMS.WebAnalytics.dll) Version: 8.2.23

Syntax

public class VisitorMethods : MacroMethodContainer

The VisitorMethods type exposes the following members.

Constructors

	Name	Description
Public method	VisitorMethods

Methods

	Name	Description
Public method Static member	GetCurrentDistance	Returns current distance (in kilometers) from specified location (based on Geo IP).
Protected method	GetExtension(String)	Returns a Extension of given name (return null if specified Extension does not exist). (Inherited from MacroExtensionContainer<TContainer, TExtension>.)
Protected method	GetExtension(Type, String)	Returns the extension by type and name. Does not cache the result. Does not cache the result. (Inherited from MacroMethodContainer.)
Protected method	GetExtensions	Gets the extensions for the given type. Does not cache the result. (Inherited from MacroMethodContainer.)
Public method	GetMethod	Returns a method of given name (return null if specified method does not exist). (Inherited from MacroMethodContainer.)
Public method Static member	GetSearchEngine	Returns search engine visitor came from.
Public method Static member	GetSearchEngineKeyword	Returns search keywords from search engine visitor came from.
Public method Static member	GetUrlReferrer	Returns absolute URI of the URLRefferer from current HTTP context.
Public method Static member	GetUrlReferrerParameter	Returns value of specified URLReferrer query string parameter.
Public method Static member	IsFirstTimeVisitor	Returns true if current visitor comes to the website for the first time.
Public method Static member	IsReturningVisitor	Returns true if current visitor is returning.
Protected method	RegisterExtension	Registers a Extension to the container. (Inherited from MacroExtensionContainer<TContainer, TExtension>.)
Protected method	RegisterExtensions	Registers all the methods. (Inherited from MacroMethodContainer.)
Public method	RegisterMethod	Registers the given method. (Inherited from MacroMethodContainer.)
Protected method	RegisterMethodInternal(String, Func<EvaluationContext, Object[], Object>, Type, String, Int32, Object[,], String[])	Registers the given method within the method table. (Inherited from MacroMethodContainer.)
Protected method	RegisterMethodInternal(String[], Func<EvaluationContext, Object[], Object>, Type, String, Int32, Object[,], String[])	Registers the given method within the method table. (Inherited from MacroMethodContainer.)
Protected method	RegisterMethods()	Registers all the methods. (Inherited from MacroMethodContainer.)
Public method	RegisterMethods(MacroMethod[])	Registers the given methods. (Inherited from MacroMethodContainer.)

Extension Methods

	Name	Description
Public Extension Method	AsValue	Converts object to a query value which can be used as a query parameter (Defined by QueryExtensions.)
Public Extension Method	GetAPIString	Gets the string by the specified resource key (Defined by CoreExtensions.)
Public Extension Method	GetString	Gets the string by the specified resource key (Defined by CoreExtensions.)
Public Extension Method	ToBoolean	Returns the boolean representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToDateTime	Returns the DateTime representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToDouble	Returns the double representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToGuid	Returns the Guid representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToInteger	Returns the integer representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToString	Returns the string representation of an object or default value if not. (Defined by CoreExtensions.)

Properties

	Name	Description
Protected property	Extensions	Extensions dictionary (Inherited from MacroExtensionContainer<TContainer, TExtension>.)
Protected property	RegisteredExtensionNames	Returns enumerable of all registered Extension names. (Inherited from MacroExtensionContainer<TContainer, TExtension>.)
Protected property	RegisteredExtensions	Returns enumerable of all Extensions. (Inherited from MacroExtensionContainer<TContainer, TExtension>.)
Public property	RegisteredMethods	Returns enumerable of all methods. (Inherited from MacroMethodContainer.)