The first piece in your FreshThemes jigsaw puzzle is laying out your forums right. You probably want your customers to get a quick snapshot of your latest, or most popular forum topics on the homepage of your support portal, and get a more detailed view when they land on the Forums page.


Placeholders for Forum Categories

Placeholder

Return Type

What they mean

forum_category.name string Returns the name of forum categories
forum_category.description string Returns the description of forum categories
forum_category.id number Unique ID of the forum category
forum_category.url url URL pointing to a forum category
forum_category.forums collection of forums Forums in the category based on visibility
forum_category.forums_count forum Forums count in the category based on visibility

Placeholders for a specific Forum

Placeholder

Return Type

What they mean

forum.name string Name of the forum
forum.description string Description of the forum
forum.url url URL pointing to the forum
forum.id number Unique ID of the forum
forum.type_name string Type of the forum (announcement, ideas, problems, questions)
filter list     
forum.current_topic_filter string Currently selected forum filter. Will work only in the respective filters page
forum.allowed_filters
Will return a hash with the below details

  • filter.name translated label of the filter

  • filter.url url link to the filter
forum.forum_category forum category Category in which the forum is present
forum.topics list of topics List of topics in the forum
forum.topics_count number Count of all topics in the forum
forum.planned_topics topic Planned topics that are available only for a ideas forum
 popular    
 answered/unanswered    
 solved/unsolved    
forum.implemented_topics topic Implemented topics that are available only for a ideas forum
forum.nottaken_topics topic Not taken topics that are available only for a ideas forum
forum.inprogress topic In progress topics that are available only for a ideas forum
forum.deferred topic Deferred topics that are available only for a ideas forum

Placeholders for a specific Topic

Placeholder
Return Type
What they mean
topic.title string Title of the forum topic
topic.id number Unique ID of the forum topic
topic.stamp string Stamp of the forum (planned, inprogress, deferred, implemented, not taken) comes only for forum type as ideas
topic.user user User who created the topic
topic.created_on date/time The timestamp denoting when the topic was created
topic.votes number No. of votes on a forum topic (can be “I like this idea”, “I have this question” or “I have this problem”)
topic.views number No. of views on a forum topic
 merge  boolean  
topic.locked? boolean Returns true or false based on whether the topic is locked or not
topic.sticky? boolean Returns true or false based on whether the topic is a sticky (that will appear on the top)
topic.answered? boolean Returns true or false based on whether the topic has been answered to or not
topic.has_comments boolean Returns true or false, used to check if the topic has any comments or not
topic.posts post List of posts inside the topic
topic.comment_count number Number of comments that have been created under a topic
topic.first_post post The first post in the topic, which was created by the original creator
topic.last_post post The last reply of the topic which is the latest in the list
topic.url url URL to a particular topic in the forum
topic.forum forum The forum in which a topic is contained
topic.attachments attachment The attachments that have been made to a topic
topic.last_post_url url URL to the last reply made to the forum topic
topic.voted_by_current_user boolean Forum topics in which users have voted (can be “I like this idea”, “I have this question” or “I have this problem”)
topic.like_url url The URL used to like a particular topic.  Need to use a data-method=”put” attribute in the link to work.
topic.unlike_url url The URL used to unlike a particular topic.  Need to use a data-method=”put” attribute in the link to work.
my_topics string List of topics that have been created or currently being followed by the user
my_topics_count number Number of topics that have been created or currently being followed by the user

Placeholders for a specific Post in the topic

Placeholder
Return Type
What they mean
post.id number Unique ID of the post
post.body string Plain text version of the post
post.body_html html Html version of the post
post.created_on date/time Time stamp referring to when the post was originally created
post.user user Information about the user who created the post
post.topic topic The topic in which the post is contained
post.answer? boolean Returns true or false based on whether there can be answers on the post or not
post.attachments attachment The attachment(s) that are available in the post
post.url url The unique URL of the post  

Here's the list of placeholders for other categories such as, General Portal Information, Managing User Access, Access to Solutions, Accessing Attachments and Using Snippets for critical behaviour.