Note: This is beta documentation and has not been finished.

Introduction

This document serves to outline the usage of object properties in Jive Forums. As a general rule property usage in Jive Forums is kept to a minimum so as to not interfer with any custom code customers may write.

Properties Used by Jive Forums

Message Properties
Property Name Type Description Usage
name String The name of the guest author of the message. Used in both the default skin and importing gateways.
email String The email of the guest author of the message. Used in both the default skin and importing gateways.
IP String The IP address used to post the message. Used in the default skin when the the skin setting to track IP's is enabled.
Parent-ID / Email-Parent-ID / NNTP-Parent-ID String The message ID of the parent message. Used by gateways to denote the message ID of the parent message.
Message-ID / Email-Message-ID / NNTP-Message-ID String The message ID of the message. Used by gateways to denote the message ID of the message.
Message-Original-Date Long The unix time that the message stated it was created. Used by gateways to store the original date of the message if the date needed to be changed to satisfy threading requirements in Jive (Jive cannot have a child message younger than a parent, which is possible with messages coming in via gateways).
Subject-Hash String A hash of the message's subject. Used by gateways when importing to determine parentage via subject line matching.
Jive-Created-Message Boolean true to indicate that the message was created by Jive. Used by gateways when importing to indicate a message was created by Jive to preserve threading.


Thread Properties
Property Name Type Description Usage
locked Boolean True if the thread is locked, false otherwise. Used in the default skin.
isQuestion Boolean True if the thread is marked as a question. Used in the default skin.
questionResolution String The resolution status of the question. One of "answered", "unanswered", or "assumed_answered". Used in the default skin.
archived Boolean True to indicate that the thread is archived. Set by the archive manager whenever a thread is archived.


User Properties
Property Name Type Description Usage
jiveAdminGroupRange Integer One of 15, 30, 50, 100 Used in the admin tool to store the user's preference as to the number of groups to show per page.
jiveAdminUserRange Integer One of 15, 30, 50, 100 Used in the admin tool to store the user's preference as to the number of users to show per page.
jiveOccupation String The user's occupation. Used in the default skin.
jiveLocation String The user's location. Used in the default skin.
jiveHomepage String The user's homepage. Used in the default skin.
jiveTimeZoneID Integer The ID of the user's timezone. Used in the default skin.
jiveLocale String The ID of the user's locale. Used in the default skin.
jiveThreadRange Integer One of 10, 15, 25, 50 Used in the default skin to save the user's preference as to the number of threads to show per page.
jiveMessageRange Integer One of 10, 15, 25, 50 Used in the default skin to save the user's preference as to the number of messages to show per page.
jiveThreadMode String One of "thread.flat", "thread.threaded" or "thread.tree". Used in the default skin to save the user's preference as to the mode to show threads in. This property is currently commented out in the default skin
jiveAutoAddEmailWatch Boolean True if Jive should automatically create new watches as email watches. Used in the default skin.
jiveAutoWatchNewTopics Boolean True if Jive should automatically create a new watch whenever the user creates a new topic. Used in the default skin.
jiveAutoWatchReplies Boolean True if Jive should automatically create a new watch whenever the user replies to a topic. Used in the default skin.
jiveBiography String The user's biography. Used in the default skin.
jiveSignature String The user's signature. Currently commented out in the default skin.
jiveSignatureVisible Boolean True if the user's signature should be visible. Currently commented out in the default skin.
jiveQuestionCount Integer The number of questions the user has created. Used in the default skin.
jive.passwordreset.token String A randomly generated string used to confirm the authenticity of the user resetting the user's password. Used in the core password resetting code.
jive.passwordreset.timestamp Long The timestamp of the last time a password reset was requested. Used in the core password resetting code.
jive.passwordreset.last_sent Long The timestamp of the last time a password reset email was sent. Used in the core password resetting code.