Click or drag to resize
URLShortenerHelper Class
Provides methods for shortening URLs using URL shortening services.
Inheritance Hierarchy
SystemObject
  CMS.BaseCoreMethods
    CMS.BaseAbstractHelper
      CMS.BaseAbstractHelperURLShortenerHelper
        CMS.SocialMarketingURLShortenerHelper

Namespace: CMS.SocialMarketing
Assembly: CMS.SocialMarketing (in CMS.SocialMarketing.dll) Version: 9.0.0
Syntax
C#
public class URLShortenerHelper : AbstractHelper<URLShortenerHelper>

The URLShortenerHelper type exposes the following members.

Constructors
  NameDescription
Public methodURLShortenerHelper
Default constructor used to create default HelperObject.
Top
Methods
  NameDescription
Public methodStatic memberGetAvailableURLShorteners
Creates a collection of available URL shorteners, and returns it.
Protected methodGetAvailableURLShortenersInternal
Creates a collection of available URL shorteners, and returns it.
Public methodStatic memberGetDefaultURLShortenerForSocialNetwork
Retrieves the URL shortener for the specified social network posts, and returns it.
Protected methodGetDefaultURLShortenerForSocialNetworkInternal
Retrieves the URL shortener for the specified social network posts, and returns it.
Protected methodGetShortenedURLInternal
Shortens provided URL
Protected methodGetURLForShortening
Prepares any found URL for shortening.
Protected methodIsURLShortened
Determines whether an URL is shortened or to be shortened.
Public methodStatic memberIsURLShortenerAvailable
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 methodIsURLShortenerAvailableInternal
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 methodSetAsDefaultHelper
Sets this object as the default helper
(Inherited from AbstractHelperHelperType.)
Public methodStatic memberShortenURLsInText
Shortens URLs in given text using selected URL shortener. Throws an exception if shortener is not available for the given site.
Protected methodShortenURLsInTextInternal
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.
Top
See Also