URLShortenerHelper Class

Provides methods for shortening URLs using URL shortening services.

Inheritance Hierarchy

System.Object
  CMS.Base.CoreMethods
    CMS.Base.AbstractHelper
      CMS.Base.AbstractHelper<URLShortenerHelper>
        CMS.SocialMarketing.URLShortenerHelper

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

Syntax

public class URLShortenerHelper : AbstractHelper<URLShortenerHelper>

The URLShortenerHelper type exposes the following members.

Constructors

	Name	Description
Public method	URLShortenerHelper	Default constructor used to create default HelperObject.

Methods

	Name	Description
Public method Static member	GetAvailableURLShorteners	Creates a collection of available URL shorteners, and returns it.
Protected method	GetAvailableURLShortenersInternal	Creates a collection of available URL shorteners, and returns it.
Public method Static member	GetDefaultURLShortenerForSocialNetwork	Retrieves the URL shortener for the specified social network posts, and returns it.
Protected method	GetDefaultURLShortenerForSocialNetworkInternal	Retrieves the URL shortener for the specified social network posts, and returns it.
Protected method	GetShortenedURLInternal	Shortens provided URL
Protected method	GetURLForShortening	Prepares any found URL for shortening.
Protected method	IsURLShortened	Determines whether an URL is shortened or to be shortened.
Public method Static member	IsURLShortenerAvailable	Provides information about availability of the URL shortener. If specified shortener is configured for given site, true is returned. False otherwise. If shortener is URLShortenerTypeEnum.None, true is returned as this shortener is always available.
Protected method	IsURLShortenerAvailableInternal	Provides information about availability of the URL shortener. If specified shortener is configured for given site, true is returned. False otherwise. If shortener is URLShortenerTypeEnum.None, true is returned as this shortener is always available.
Public method	SetAsDefaultHelper	Sets this object as the default helper (Inherited from AbstractHelper<HelperType>.)
Public method Static member	ShortenURLsInText	Shortens URLs in given text using selected URL shortener. Throws an exception if shortener is not available for the given site.
Protected method	ShortenURLsInTextInternal	Shortens all URLs in provided text. Returns the same text with all URLs shortened by the specified shortener. If shortener is URLShortenerTypeEnum.None, original inputText is returned.

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