|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.atlassian.gadgets.GadgetRequestContext
public final class GadgetRequestContext
Holds information associated with a gadget request that the system will need
to use.
GadgetRequestContext
objects should be created using the GadgetRequestContext.Builder
class. By doing a
static import of the GadgetRequestContext.Builder.gadgetRequestContext()
method, you can create a GadgetRequestContext
as follows:
GadgetRequestContext gadgetRequestContext = gadgetRequestContext().viewer("Bob").build();
Nested Class Summary | |
---|---|
static class |
GadgetRequestContext.Builder
A builder that facilitates construction of GadgetRequestContext objects. |
Field Summary | |
---|---|
static GadgetRequestContext |
NO_CURRENT_REQUEST
|
Method Summary | |
---|---|
boolean |
getIgnoreCache()
Returns the cache setting used for this request. |
Locale |
getLocale()
Returns the locale used for this request. |
String |
getViewer()
Returns the viewer (the current user) for this request. |
boolean |
isDebuggingEnabled()
Returns true if the gadget should be rendered with debugging enabled, otherwise. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final GadgetRequestContext NO_CURRENT_REQUEST
Method Detail |
---|
public Locale getLocale()
Locale
used for this requestpublic boolean getIgnoreCache()
RequestCacheSetting
used for this requestpublic String getViewer()
String
representing the viewer for this requestpublic boolean isDebuggingEnabled()
true
if the gadget should be rendered with debugging enabled, otherwise. When this
returns true
, the JavaScript for the features used by the gadget will be served in non-minimized, making
it easier to debug.
true
if the gadget should be rendered with debugging enabled, otherwise
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |