Blog Type

A container for a list of blog postings by a user or group of users. Every blog is associated with one container, and multiple users may have permissions to post to the blog. Each blog can have an arbitrary number of extended properties, which allow extra data about the blog to be stored.

Type Template

<...>
    <ID>xs:long</ID>
    <objectType>xs:int</objectType>
    <!-- List of ... -->
    <allBlogPostIDs>Long</allBlogPostIDs>
    <blogPostCount>xs:int</blogPostCount>
    <commentAuthenticationStrategy>xs:int</commentAuthenticationStrategy>
    <commentCount>xs:int</commentCount>
    <commentModerationEnabled>xs:boolean</commentModerationEnabled>
    <commentNotificationEnabled>xs:boolean</commentNotificationEnabled>
    <creationDate>xs:dateTime</creationDate>
    <description>xs:string</description>
    <displayName>xs:string</displayName>
    <feedEnabled>xs:boolean</feedEnabled>
    <feedFullContent>xs:boolean</feedFullContent>
    <firstPostID>xs:long</firstPostID>
    <lastPostID>xs:long</lastPostID>
    <modificationDate>xs:dateTime</modificationDate>
    <name>xs:string</name>
    <overridePing>xs:boolean</overridePing>
    <pingServices>xs:string</pingServices>
    <!-- List of ... -->
    <popularTags>
        <!-- Contents of TagCount -->
    <popularTags>
    <!-- List of ... -->
    <properties>
        <!-- Contents of Property -->
    <properties>
    <!-- List of ... -->
    <recentBlogPostIDs>Long</recentBlogPostIDs>
    <!-- List of ... -->
    <recentCommentIDs>Long</recentCommentIDs>
    <systemBlog>xs:boolean</systemBlog>
    <!-- List of ... -->
    <tags>
        <!-- Contents of TagCount -->
    <tags>
    <trackbackCount>xs:int</trackbackCount>
    <trackbackModerationEnabled>xs:boolean</trackbackModerationEnabled>
    <trackbackNotificationEnabled>xs:boolean</trackbackNotificationEnabled>
    <userBlog>xs:boolean</userBlog>
    <userCount>xs:int</userCount>
    <!-- List of ... -->
    <userIDs>Long</userIDs>
<...>

Note: Element descriptions are split into information that's relevant when you're creating an instance of this type and information relevant when you're receiving an instance of it. Occasionally these will differ.

Elements

Element Description
allBlogPostIDs
Setting
Sets all the blog post IDs for this blog.
Getting
Returns all the blog post IDs for this blog.
blogPostCount
Setting
Sets the number of blog posts on this blog.
Getting
Returns the number of blog posts on this blog, by default only includes blog posts where status = 2 (STATUS_PUBLISH) and publish date less than now().
commentAuthenticationStrategy
Setting
Set the comment authentication strategy of this blog which may be any one of the following:
  • 1 (COMMENT_AUTH_REQUIRED) -- must register and login to comment
  • 2 (COMMENT_AUTH_OPTIONAL_WITH_EMAIL) -- must either register and login or provide an email address in the comment form.
  • 3 (COMMENT_AUTH_OPTIONAL) -- no registration / login or email address required.
Getting
Returns the comment authentication strategy of this blog which may be any one of the following:
  • 1 (COMMENT_AUTH_REQUIRED) -- must register and login to comment
  • 2 (COMMENT_AUTH_OPTIONAL_WITH_EMAIL) -- must either register and login or provide an email address in the comment form.
  • 3 (COMMENT_AUTH_OPTIONAL) -- no registration / login or email address required.
Defaults to 1 (COMMENT_AUTH_REQUIRED) .
commentCount
Setting
Sets the total number of comments on this blog.
Getting
Returns the total number of comments on this blog.
commentModerationEnabled
Setting
Enables and disables comment moderation for this blog. Default is false.
Getting
Returns true if comment moderation is enabled for this blog, false if not. Default is false.
commentNotificationEnabled
Setting
Enables and disables comment notification for this blog. Default is true.
Getting
Returns true if comment notification is enabled for this blog, false if not. Default is true.
creationDate
Setting
Sets the creation date of this blog. In most cases, the creation date will default to when the blog was entered into the system. However, the creation date needs to be set manually when importing data. In other words, skin authors should ignore this method since it only intended for system maintenance.
Getting
Returns the date that this blog was created.
description
Setting
Sets the description of the blog, max length of 255 characters.
Getting
Returns the description of the blog.
displayName
Setting
Sets the display name of the blog that is used as the URI. The display name will be used as part of the URI and is necessary both for users who want to name their blog something different than their username and also for system blogs, where the username wouldn't be adequate by itself. Example:

http://jivesoftware.org/community/blogs/openfireteam

This method will throw an IllegalArgumentException if

  • the new name is already associated with another blog
  • the new name is the same as the username of another user
  • if the name contains any non-alphanumeric characters
Use the method to find out if a blog with the new name already exists and BlogUtils.isValidDisplayName(java.lang.String) to test a string for non alphanumeric characters.
Getting
Gets the display name of a blog.
feedEnabled
Setting
Enables and disables feeds for this blog. Default is true
Getting
Returns true if feeds are enabled for this blog, false if not. Default is true.
feedFullContent
Setting
Enables or disables the publishing of the full blog post in feeds. Default is true.
Getting
Returns true if the full blog post should be published in feeds, false to instead include an excerpt of the blog post. Default is true.
firstPostID
Setting
Sets the first blog post ID on this blog.
Getting
Returns the first blog post ID on this blog.
ID
Setting
Set the unique id of this object.
Getting
lastPostID
Setting
Sets the last blog post ID on this blog.
Getting
Returns the last blog post ID on this blog.
modificationDate
Setting
Sets the date this blog was last modified. In most cases, last modifed will default to when the blog data was last changed. However, the last modified date needs to be set manually when importing data. In other words, skin authors should ignore this method since it only intended for system maintenance.
Getting
Returns the date that the blog name, display name or description was last modified.
name
Setting
Sets the name of a blog.
Getting
objectType
Setting
Sets the object type of the jive object.
Getting
overridePing
Setting
Enables or disables the blog to override the ping settings in the system. Default is false.
Getting
Returns true if the blog has been configured to override the system settings, false to use the system blog ping settings. Default is false.
pingServices
Setting
A line break separated list of services that the user has chosen to ping.
Getting
Returns a line break separated list of services that the user has chosen to ping.
popularTags
Setting
Sets the 20 most popular tags for a given blog.
Getting
Returns the 20 most popular tags for a given blog in a Map where the key is the name of tag and the value is the number of times the tag has been used in this blog.
properties
Setting
Set the properties associated with this blog.
Getting
Returns the properties associated with this blog.
recentBlogPostIDs
Setting
Sets the the most recent blog post IDs on this blog
Getting
Returns (at most) the ten most recent blog postsIDs on this blog.
recentCommentIDs
Setting
Sets the most recent comment IDs on this blog.
Getting
Returns (at most) the ten most recent comment IDs on this blog.
systemBlog
Setting
Sets the local value of system blog - has no effect on the actual blog's container.
Getting
Indicates if the blog is a shared, system-level blog.
tags
Setting
Sets the tags for a given blog.
Getting
trackbackCount
Setting
Sets the total number of trackbacks on this blog.
Getting
Returns the total number of trackbacks on this blog.
trackbackModerationEnabled
Setting
Enables and disables trackback moderation for this blog. Default is false.
Getting
Returns true if trackback moderation is enabled for this blog, false if not. Default is false.
trackbackNotificationEnabled
Setting
Enables and disables trackback notification for this blog. Default is true.
Getting
Returns true if trackback notification is enabled for this blog, false if not. Default is true.
userBlog
Setting
Sets the local value of user blog - has no effect on the actual blog's container.
Getting
Inficates if the blog is a user's personal blog.
userCount
Setting
Sets the number of users associated with this blog.
Getting
Returns the number of users associated with this blog.
userIDs
Setting
Sets the user IDs given permission to post to this blog.
Getting
Return all the user IDs given permission to post to this blog.