GeoIPHelper Class

Provides IP address to GEO location conversion.

Inheritance Hierarchy

System.Object
  CMS.Base.CoreMethods
    CMS.Base.AbstractHelper
      CMS.Base.AbstractHelper<GeoIPHelper>
        CMS.WebAnalytics.GeoIPHelper

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

Syntax

public class GeoIPHelper : AbstractHelper<GeoIPHelper>

The GeoIPHelper type exposes the following members.

Constructors

	Name	Description
Public method	GeoIPHelper

Methods

	Name	Description
Public method Static member	ClearLookUpServices	Clears MaxMind GeoIP lookup services.
Public method Static member	GetCountryByIp	Finds country name by IP4 address.
Protected method	GetCountryByIpInternal	Finds country name by IP4 address.
Public method Static member	GetCountryIDByIp	Finds ID of country from CMS_Country table by IP4 address.
Protected method	GetCountryIDByIpInternal	Finds ID of country from CMS_Country table by IP4 address.
Public method Static member	GetCurrentGeoLocation	Returns geo location according to current IP (RequestContext.UserHostAddress).
Public method Static member	GetLocationByIp	Returns location object according to IP4 address.
Public method	GetLocationByIpInternal	Returns location object according to IP4 address.
Public method Static member	GetOrganizationByIp	Finds organization/company name by IP4 address.
Protected method	GetOrganizationByIpInternal	Finds organization/company name by IP4 address.
Public method Static member	GetStateByIp	Finds state code name by IP4 address.
Protected method	GetStateByIpInternal	Finds state code name by IP4 address.
Public method Static member	GetStateIDByIp	Finds ID of state from CMS_State table by IP4 address.
Protected method	GetStateIDByIpInternal	Finds ID of state from CMS_State table by IP4 address.
Public method Static member	InitIPToLocationService	Initializes the IP to location service with options.
Public method Static member	InitIPToOrgService	Initializes the IP to organization service with options.
Public method	SetAsDefaultHelper	Sets this object as the default helper (Inherited from AbstractHelper<HelperType>.)

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.)