C# Class CkanDotNet.Web.Models.Helpers.SettingsHelper

Afficher le fichier Open project: opencolorado/.NET-Wrapper-for-CKAN-API

Méthodes publiques

Méthode Description
FilterTitle ( Package package ) : void

Filter the package title with the package title prefix.
FilterTitles ( List packages ) : void

Filter the package titles with the package title prefix.
GetAddThisCustomWidgetEnabled ( ) : bool

Is an AddThis customer widget enabled
GetAddThisEnabled ( ) : bool

Are AddThis buttons enabled
GetAddThisProfileId ( ) : string

Get the AddThis profile id
GetAllLicensesCacheBackgroundUpdate ( ) : bool

Automatically update the all licenses cache in the background
GetAllLicensesCacheDuration ( ) : System.TimeSpan

Get the duration to cache information about all licenses.
GetAllPackagesCacheBackgroundUpdate ( ) : bool

Automatically update the all packages cache in the background
GetAllPackagesCacheDuration ( ) : System.TimeSpan

Get the duration to cache the full package list.
GetBreadcrumbsEnabled ( ) : bool

Gets the enabled status of the breadcrumbs
GetBreadcrumbsHomeEnabled ( ) : bool

Gets the enabled status of the breadcrumbs on the home page
GetCacheAdminToken ( ) : string

Gets the key required for administering the cache
GetCatalogBreadcrumbsBaseLabel ( ) : string

Gets the label to use for the base breadcrumb
GetCatalogGroup ( ) : string

Get the list of groups that have been configured in the settings.
GetCatalogHiddenTags ( ) : List

Get the list of hidden tags that have been configured in the settings
GetCatalogPackageTitlePrefix ( ) : string

Get the prefix for package titles. The prefix is removed from package names as the prefix is not necessary in a filtered catalog.
GetCatalogTheme ( ) : string

Gets the current theme name
GetDatasetTitleLength ( ) : int

Get the maximum length of a dataset title.
GetDisqusDeveloperModeEnabled ( ) : bool

Is Disqus developer mode enabled
GetDisqusForumShortName ( ) : string

Get the Disqus forum short name
GetDisqusPackageEnabled ( ) : bool

Are Disqus forums enabled on packages
GetDownloadProxyEnabled ( ) : bool

Is the download proxy enabled
GetDownloadProxyLocation ( string root, bool &rootLocationFound ) : Uri

Get the download proxy location
GetDownloadProxyRoute ( ) : string

Get the download proxy route
GetFeaturedPackagesCacheDuration ( ) : System.TimeSpan

Get the duration to cache featured packages.
GetGoogleAnalyticsDomainName ( ) : string

Gets the Google Analytics Domain Name
GetGoogleAnalyticsEnabled ( ) : bool

Is Google Analytics enabled
GetGoogleAnalyticsLinkerAllowed ( ) : bool

Is Google Analytics linker allowed
GetGoogleAnalyticsProfile ( ) : string

Gets the Google Analytics profile
GetHomeBrowseAllPackagesEnabled ( ) : bool

Should browsing of all packages be displayed on the home page
GetHomeFeaturedPackageLimit ( ) : int

Get the maximum number of featured packages to display on the home page
GetHomeFeaturedPackagesEnabled ( ) : bool

Should featured packages be displayed on the home page
GetHomeFeaturedPackagesTag ( ) : string

Gets the tag to use for featured packages
GetHomePageTitle ( ) : string

Gets the page title for the home page
GetHomePopularTagsEnabled ( ) : bool

Should popular tags be displayed on the home page
GetHomePopularTagsLimit ( ) : int

Get the maximum number of popular tags to display on the home page
GetHomeRecentlyUpdatedPackagesEnabled ( ) : bool

Should recently updated packages be displayed on the home page
GetIframeDocumentDomain ( ) : string

Get the document domain for the iframe.
GetIframeEnabled ( ) : bool

Gets the enabled status of enhanced iframe support
GetIframeId ( ) : string

Get the id of the iframe on the parent page.
GetIframeSrc ( ) : string

Get the source of the iframe on the parent page.
GetJQuerySource ( ) : string

Get the jQuery source
GetOfflineEnabled ( ) : bool

Is the data catalog currently offline
GetOfflineMessage ( ) : string

Get the offline message
GetOfflineTitle ( ) : string

Get the offline title
GetPackageCacheDuration ( ) : System.TimeSpan

Get the duration to cache package details.
GetPackageCountCacheBackgroundUpdate ( ) : bool

Automatically update the package count cache in the background
GetPackageCountCacheDuration ( ) : System.TimeSpan

Get the duration to cache the pacakge count
GetPackageExtraFieldLabel ( string field ) : string

Get the label for a package 'extra' field.
GetPackagePageTitle ( ) : string

Gets the page title for the package page
GetPackageRelatedItemsEnabled ( ) : bool

Is the package related items section enabled
GetPackageRssFeedDays ( ) : int

Get the list of groups that have been configured in the settings.
GetPackageRssFeedEnabled ( ) : bool

Is the package RSS feed link enabled
GetPackageUseThemeLicenseTemplate ( ) : bool

Use the license block from the theme license page (_License). Uses the standard CKAN license information by default.
GetRepositoryHost ( ) : string

Get the list of groups that have been configured in the settings.
GetRepositoryRequestTimeout ( ) : int

Get the respository request timeout in milliseconds.
GetResourceSettings ( ) : ResourceSettings

Get the resource settings (custom actions for CKAN resource types)
GetSearchPageTitle ( ) : string

Gets the page title for the search page
GetSearchResultsCacheDuration ( ) : System.TimeSpan

Get the duration to cache search results.
GetSearchResultsMaxPagesToShowInPager ( ) : int

Get the max number of pages to show in the pager. A moving window around the current page will be used.
GetSearchResultsPerPage ( ) : int

Get the maximum number of search results to show per page.
GetSearchResultsShowRating ( ) : bool

Is the rating shown in the search results
GetSearchResultsShowTags ( ) : bool

Are the tags shown in the search results
GetSeoCommonPackageKeywords ( ) : List

Gets common package keywords to display in the meta keywords for every package page
GetSeoHomeDescription ( ) : string

The meta tag description for the home page
GetSeoHomeKeywords ( ) : List

The meta tag keywords for the home page
GetSeoPackageDescriptionLength ( ) : int

Get the maximum number of characters to use in the package description meta tag.
GetSeoSiteMapBaseUrl ( ) : string

The base map to use for the URLs in the sitemap. This setting is used if the adminstrator wants to override the default url (for example, if using a reverse proxy).
GetSuggestionsDelay ( ) : int

Set the delay time for queueing keystokes before requesting suggestions.
GetSuggestionsEnabled ( ) : bool

Are suggestions enabled
GetTagCloudMaxScale ( ) : int

The maximum scale for the tag cloud
GetTagCloudMinScale ( ) : int

The minimum scale for the tag cloud (percent)
GetTagCloudShowCount ( ) : bool

Should the count be displayed beside the tag
GetUserVoiceEnabled ( ) : bool

Are UserVoice suggestions enabled
GetUserVoiceKey ( ) : string

Get the UserVoice widget key

Private Methods

Méthode Description
GetKeywordsFromSetting ( string setting ) : List

Get comma-delimited keywords from a setting.
GetList ( string key ) : List

Get a list of comma delimited items from the a key in the settings

Method Details

FilterTitle() public static méthode

Filter the package title with the package title prefix.
public static FilterTitle ( Package package ) : void
package CkanDotNet.Api.Model.Package
Résultat void

FilterTitles() public static méthode

Filter the package titles with the package title prefix.
public static FilterTitles ( List packages ) : void
packages List
Résultat void

GetAddThisCustomWidgetEnabled() public static méthode

Is an AddThis customer widget enabled
public static GetAddThisCustomWidgetEnabled ( ) : bool
Résultat bool

GetAddThisEnabled() public static méthode

Are AddThis buttons enabled
public static GetAddThisEnabled ( ) : bool
Résultat bool

GetAddThisProfileId() public static méthode

Get the AddThis profile id
public static GetAddThisProfileId ( ) : string
Résultat string

GetAllLicensesCacheBackgroundUpdate() public static méthode

Automatically update the all licenses cache in the background
public static GetAllLicensesCacheBackgroundUpdate ( ) : bool
Résultat bool

GetAllLicensesCacheDuration() public static méthode

Get the duration to cache information about all licenses.
public static GetAllLicensesCacheDuration ( ) : System.TimeSpan
Résultat System.TimeSpan

GetAllPackagesCacheBackgroundUpdate() public static méthode

Automatically update the all packages cache in the background
public static GetAllPackagesCacheBackgroundUpdate ( ) : bool
Résultat bool

GetAllPackagesCacheDuration() public static méthode

Get the duration to cache the full package list.
public static GetAllPackagesCacheDuration ( ) : System.TimeSpan
Résultat System.TimeSpan

GetBreadcrumbsEnabled() public static méthode

Gets the enabled status of the breadcrumbs
public static GetBreadcrumbsEnabled ( ) : bool
Résultat bool

GetBreadcrumbsHomeEnabled() public static méthode

Gets the enabled status of the breadcrumbs on the home page
public static GetBreadcrumbsHomeEnabled ( ) : bool
Résultat bool

GetCacheAdminToken() public static méthode

Gets the key required for administering the cache
public static GetCacheAdminToken ( ) : string
Résultat string

GetCatalogBreadcrumbsBaseLabel() public static méthode

Gets the label to use for the base breadcrumb
public static GetCatalogBreadcrumbsBaseLabel ( ) : string
Résultat string

GetCatalogGroup() public static méthode

Get the list of groups that have been configured in the settings.
public static GetCatalogGroup ( ) : string
Résultat string

GetCatalogHiddenTags() public static méthode

Get the list of hidden tags that have been configured in the settings
public static GetCatalogHiddenTags ( ) : List
Résultat List

GetCatalogPackageTitlePrefix() public static méthode

Get the prefix for package titles. The prefix is removed from package names as the prefix is not necessary in a filtered catalog.
public static GetCatalogPackageTitlePrefix ( ) : string
Résultat string

GetCatalogTheme() public static méthode

Gets the current theme name
public static GetCatalogTheme ( ) : string
Résultat string

GetDatasetTitleLength() public static méthode

Get the maximum length of a dataset title.
public static GetDatasetTitleLength ( ) : int
Résultat int

GetDisqusDeveloperModeEnabled() public static méthode

Is Disqus developer mode enabled
public static GetDisqusDeveloperModeEnabled ( ) : bool
Résultat bool

GetDisqusForumShortName() public static méthode

Get the Disqus forum short name
public static GetDisqusForumShortName ( ) : string
Résultat string

GetDisqusPackageEnabled() public static méthode

Are Disqus forums enabled on packages
public static GetDisqusPackageEnabled ( ) : bool
Résultat bool

GetDownloadProxyEnabled() public static méthode

Is the download proxy enabled
public static GetDownloadProxyEnabled ( ) : bool
Résultat bool

GetDownloadProxyLocation() public static méthode

Get the download proxy location
public static GetDownloadProxyLocation ( string root, bool &rootLocationFound ) : Uri
root string
rootLocationFound bool
Résultat System.Uri

GetDownloadProxyRoute() public static méthode

Get the download proxy route
public static GetDownloadProxyRoute ( ) : string
Résultat string

GetFeaturedPackagesCacheDuration() public static méthode

Get the duration to cache featured packages.
public static GetFeaturedPackagesCacheDuration ( ) : System.TimeSpan
Résultat System.TimeSpan

GetGoogleAnalyticsDomainName() public static méthode

Gets the Google Analytics Domain Name
public static GetGoogleAnalyticsDomainName ( ) : string
Résultat string

GetGoogleAnalyticsEnabled() public static méthode

Is Google Analytics enabled
public static GetGoogleAnalyticsEnabled ( ) : bool
Résultat bool

GetGoogleAnalyticsLinkerAllowed() public static méthode

Is Google Analytics linker allowed
public static GetGoogleAnalyticsLinkerAllowed ( ) : bool
Résultat bool

GetGoogleAnalyticsProfile() public static méthode

Gets the Google Analytics profile
public static GetGoogleAnalyticsProfile ( ) : string
Résultat string

GetHomeBrowseAllPackagesEnabled() public static méthode

Should browsing of all packages be displayed on the home page
public static GetHomeBrowseAllPackagesEnabled ( ) : bool
Résultat bool

GetHomeFeaturedPackageLimit() public static méthode

Get the maximum number of featured packages to display on the home page
public static GetHomeFeaturedPackageLimit ( ) : int
Résultat int

GetHomeFeaturedPackagesEnabled() public static méthode

Should featured packages be displayed on the home page
public static GetHomeFeaturedPackagesEnabled ( ) : bool
Résultat bool

GetHomeFeaturedPackagesTag() public static méthode

Gets the tag to use for featured packages
public static GetHomeFeaturedPackagesTag ( ) : string
Résultat string

GetHomePageTitle() public static méthode

Gets the page title for the home page
public static GetHomePageTitle ( ) : string
Résultat string

GetHomePopularTagsEnabled() public static méthode

Should popular tags be displayed on the home page
public static GetHomePopularTagsEnabled ( ) : bool
Résultat bool

GetHomePopularTagsLimit() public static méthode

Get the maximum number of popular tags to display on the home page
public static GetHomePopularTagsLimit ( ) : int
Résultat int

GetHomeRecentlyUpdatedPackagesEnabled() public static méthode

Should recently updated packages be displayed on the home page
public static GetHomeRecentlyUpdatedPackagesEnabled ( ) : bool
Résultat bool

GetIframeDocumentDomain() public static méthode

Get the document domain for the iframe.
public static GetIframeDocumentDomain ( ) : string
Résultat string

GetIframeEnabled() public static méthode

Gets the enabled status of enhanced iframe support
public static GetIframeEnabled ( ) : bool
Résultat bool

GetIframeId() public static méthode

Get the id of the iframe on the parent page.
public static GetIframeId ( ) : string
Résultat string

GetIframeSrc() public static méthode

Get the source of the iframe on the parent page.
public static GetIframeSrc ( ) : string
Résultat string

GetJQuerySource() public static méthode

Get the jQuery source
public static GetJQuerySource ( ) : string
Résultat string

GetOfflineEnabled() public static méthode

Is the data catalog currently offline
public static GetOfflineEnabled ( ) : bool
Résultat bool

GetOfflineMessage() public static méthode

Get the offline message
public static GetOfflineMessage ( ) : string
Résultat string

GetOfflineTitle() public static méthode

Get the offline title
public static GetOfflineTitle ( ) : string
Résultat string

GetPackageCacheDuration() public static méthode

Get the duration to cache package details.
public static GetPackageCacheDuration ( ) : System.TimeSpan
Résultat System.TimeSpan

GetPackageCountCacheBackgroundUpdate() public static méthode

Automatically update the package count cache in the background
public static GetPackageCountCacheBackgroundUpdate ( ) : bool
Résultat bool

GetPackageCountCacheDuration() public static méthode

Get the duration to cache the pacakge count
public static GetPackageCountCacheDuration ( ) : System.TimeSpan
Résultat System.TimeSpan

GetPackageExtraFieldLabel() public static méthode

Get the label for a package 'extra' field.
public static GetPackageExtraFieldLabel ( string field ) : string
field string
Résultat string

GetPackagePageTitle() public static méthode

Gets the page title for the package page
public static GetPackagePageTitle ( ) : string
Résultat string

GetPackageRelatedItemsEnabled() public static méthode

Is the package related items section enabled
public static GetPackageRelatedItemsEnabled ( ) : bool
Résultat bool

GetPackageRssFeedDays() public static méthode

Get the list of groups that have been configured in the settings.
public static GetPackageRssFeedDays ( ) : int
Résultat int

GetPackageRssFeedEnabled() public static méthode

Is the package RSS feed link enabled
public static GetPackageRssFeedEnabled ( ) : bool
Résultat bool

GetPackageUseThemeLicenseTemplate() public static méthode

Use the license block from the theme license page (_License). Uses the standard CKAN license information by default.
public static GetPackageUseThemeLicenseTemplate ( ) : bool
Résultat bool

GetRepositoryHost() public static méthode

Get the list of groups that have been configured in the settings.
public static GetRepositoryHost ( ) : string
Résultat string

GetRepositoryRequestTimeout() public static méthode

Get the respository request timeout in milliseconds.
public static GetRepositoryRequestTimeout ( ) : int
Résultat int

GetResourceSettings() public static méthode

Get the resource settings (custom actions for CKAN resource types)
public static GetResourceSettings ( ) : ResourceSettings
Résultat CkanDotNet.Web.Models.Settings.ResourceSettings

GetSearchPageTitle() public static méthode

Gets the page title for the search page
public static GetSearchPageTitle ( ) : string
Résultat string

GetSearchResultsCacheDuration() public static méthode

Get the duration to cache search results.
public static GetSearchResultsCacheDuration ( ) : System.TimeSpan
Résultat System.TimeSpan

GetSearchResultsMaxPagesToShowInPager() public static méthode

Get the max number of pages to show in the pager. A moving window around the current page will be used.
public static GetSearchResultsMaxPagesToShowInPager ( ) : int
Résultat int

GetSearchResultsPerPage() public static méthode

Get the maximum number of search results to show per page.
public static GetSearchResultsPerPage ( ) : int
Résultat int

GetSearchResultsShowRating() public static méthode

Is the rating shown in the search results
public static GetSearchResultsShowRating ( ) : bool
Résultat bool

GetSearchResultsShowTags() public static méthode

Are the tags shown in the search results
public static GetSearchResultsShowTags ( ) : bool
Résultat bool

GetSeoCommonPackageKeywords() public static méthode

Gets common package keywords to display in the meta keywords for every package page
public static GetSeoCommonPackageKeywords ( ) : List
Résultat List

GetSeoHomeDescription() public static méthode

The meta tag description for the home page
public static GetSeoHomeDescription ( ) : string
Résultat string

GetSeoHomeKeywords() public static méthode

The meta tag keywords for the home page
public static GetSeoHomeKeywords ( ) : List
Résultat List

GetSeoPackageDescriptionLength() public static méthode

Get the maximum number of characters to use in the package description meta tag.
public static GetSeoPackageDescriptionLength ( ) : int
Résultat int

GetSeoSiteMapBaseUrl() public static méthode

The base map to use for the URLs in the sitemap. This setting is used if the adminstrator wants to override the default url (for example, if using a reverse proxy).
public static GetSeoSiteMapBaseUrl ( ) : string
Résultat string

GetSuggestionsDelay() public static méthode

Set the delay time for queueing keystokes before requesting suggestions.
public static GetSuggestionsDelay ( ) : int
Résultat int

GetSuggestionsEnabled() public static méthode

Are suggestions enabled
public static GetSuggestionsEnabled ( ) : bool
Résultat bool

GetTagCloudMaxScale() public static méthode

The maximum scale for the tag cloud
public static GetTagCloudMaxScale ( ) : int
Résultat int

GetTagCloudMinScale() public static méthode

The minimum scale for the tag cloud (percent)
public static GetTagCloudMinScale ( ) : int
Résultat int

GetTagCloudShowCount() public static méthode

Should the count be displayed beside the tag
public static GetTagCloudShowCount ( ) : bool
Résultat bool

GetUserVoiceEnabled() public static méthode

Are UserVoice suggestions enabled
public static GetUserVoiceEnabled ( ) : bool
Résultat bool

GetUserVoiceKey() public static méthode

Get the UserVoice widget key
public static GetUserVoiceKey ( ) : string
Résultat string