public.javadoc.org.spincast.plugins.timezoneresolver.config.SpincastTimeZoneResolverConfig.html Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of spincast-website Show documentation

Source code for the https://www.spincast.org website.

There is a newer version: 2.2.0







SpincastTimeZoneResolverConfig (org.spincast:spincast-framework 1.0.0 API)











Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help

 Spincast Framework Javadoc



Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method








org.spincast.plugins.timezoneresolver.config
Interface SpincastTimeZoneResolverConfig






All Known Implementing Classes:
SpincastTimeZoneResolverConfigDefault




public interface SpincastTimeZoneResolverConfig
Configurations for the Spincast TimeZone Resolver plugin.











Method Summary

All Methods Instance Methods Abstract Methods 

Modifier and Type
Method and Description


String
getPebbleTimeZoneCookieDomain()
The domain to use for the TimeZone coookie.



int
getPebbleTimeZoneCookieExpiredHoursNbr()
The number of hours the timeZone cookie will
 live.



String
getPebbleTimeZoneCookiePath()
The path to use for the TimeZone coookie.



String
getPebbleTimeZoneCookieReloadingQsParamName()
The name of the querystring parameter that
 will be used is reloading the page after the
 timeZone cookie is set is enabled.



boolean
isRefreshPageAfterAddingPebbleTimeZoneCookie()
Should the page be refreshed once the TimeZone
 cookie has been set for the first time?
















Method Detail





isRefreshPageAfterAddingPebbleTimeZoneCookie
boolean isRefreshPageAfterAddingPebbleTimeZoneCookie()
Should the page be refreshed once the TimeZone
 cookie has been set for the first time?
 
 This allows you to obtain the timeZone of the user
 even before rendering the very first page he visits.
 Simply put {{ timeZoneCookie(true) }}
 very high in the header of the page!
 

 Defaults to true.







getPebbleTimeZoneCookieDomain
String getPebbleTimeZoneCookieDomain()
The domain to use for the TimeZone coookie.
 Default to "." + the app domain, which makes
 the cookie available to all sud domains.







getPebbleTimeZoneCookiePath
String getPebbleTimeZoneCookiePath()
The path to use for the TimeZone coookie.
 
 Defaults to "/".







getPebbleTimeZoneCookieReloadingQsParamName
String getPebbleTimeZoneCookieReloadingQsParamName()
The name of the querystring parameter that
 will be used is reloading the page after the
 timeZone cookie is set is enabled.
 
 Defaults to "spincast_tz".







getPebbleTimeZoneCookieExpiredHoursNbr
int getPebbleTimeZoneCookieExpiredHoursNbr()
The number of hours the timeZone cookie will
 live.
 
 Defaults to 10 years.













Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help

 Spincast Framework Javadoc



Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method






Copyright © 2019. All rights reserved.

Modifier and Type	Method and Description
`String`	`getPebbleTimeZoneCookieDomain()` The domain to use for the TimeZone coookie.
`int`	`getPebbleTimeZoneCookieExpiredHoursNbr()` The number of hours the timeZone cookie will live.
`String`	`getPebbleTimeZoneCookiePath()` The path to use for the TimeZone coookie.
`String`	`getPebbleTimeZoneCookieReloadingQsParamName()` The name of the querystring parameter that will be used is reloading the page after the timeZone cookie is set is enabled.
`boolean`	`isRefreshPageAfterAddingPebbleTimeZoneCookie()` Should the page be refreshed once the TimeZone cookie has been set for the first time?