com.jivesoftware.base.plugin
Class MacroContext

java.lang.Object
  com.jivesoftware.base.plugin.MacroContext

public class MacroContext
extends Object

Provides extra information to the macro.

Field Summary

protected JiveContentObject	contentObject
protected JiveContext	jiveContext
protected com.jivesoftware.base.plugin.PluginMetaData	pluginMetaData
protected User	user

Constructor Summary

MacroContext(JiveContext jiveContext, com.jivesoftware.base.plugin.PluginMetaData pluginMetaData, JiveContentObject contentObject, User user)

Method Summary

JiveContentObject	getContentObject() Returns the object this macro is being used inside of.
JiveContext	getJiveContext() Returns a JiveContext object providing access to the clearspace api.
com.jivesoftware.base.plugin.PluginMetaData	getPluginMetaData() Returns meta data about the plugin this macro is deployed in.
User	getUser() Returns the current user logged in if the user is not a guest, if the user is a guest null will be returned.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

jiveContext

protected final JiveContext jiveContext

pluginMetaData

protected final com.jivesoftware.base.plugin.PluginMetaData pluginMetaData

contentObject

protected final JiveContentObject contentObject

user

protected final User user

Constructor Detail

MacroContext

public MacroContext(JiveContext jiveContext,
                    com.jivesoftware.base.plugin.PluginMetaData pluginMetaData,
                    JiveContentObject contentObject,
                    User user)

Method Detail

getJiveContext

public JiveContext getJiveContext()

Returns a JiveContext object providing access to the clearspace api.

Returns:

a JiveContext object providing access to the clearspace api.

getPluginMetaData

public com.jivesoftware.base.plugin.PluginMetaData getPluginMetaData()

Returns meta data about the plugin this macro is deployed in.

Returns:

Meta data from the macro.

getContentObject

public JiveContentObject getContentObject()

Returns the object this macro is being used inside of. It will be a type such as Thread or BlogPost.

Returns:

the object this macro is being used inside of.

getUser

public User getUser()

Returns the current user logged in if the user is not a guest, if the user is a guest null will be returned.

Returns:

Current logged in user if there is one.