BlogPost Type

A container for blog post data and for a hierarchy of blog comments.

Type Template

<...>
    <ID>xs:long</ID>
    <objectType>xs:int</objectType>
    <attachmentCount>xs:int</attachmentCount>
    <blogID>xs:long</blogID>
    <body>xs:string</body>
    <commentCount>xs:int</commentCount>
    <commentStatus>xs:int</commentStatus>
    <creationDate>xs:dateTime</creationDate>
    <imageCount>xs:int</imageCount>
    <modificationDate>xs:dateTime</modificationDate>
    <nextPostID>xs:long</nextPostID>
    <permalink>xs:string</permalink>
    <plainBody>xs:string</plainBody>
    <plainSubject>xs:string</plainSubject>
    <previousPostID>xs:long</previousPostID>
    <!-- List of ... -->
    <properties>
        <!-- Contents of Property -->
    <properties>
    <publishDate>xs:dateTime</publishDate>
    <status>xs:int</status>
    <subject>xs:string</subject>
    <!-- List of ... -->
    <tags>xs:string</tags>
    <trackbacksEnabled>xs:boolean</trackbacksEnabled>
    <unfilteredSubject>xs:string</unfilteredSubject>
    <user>
        <!-- Contents of User -->
    <user>
<...>

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
attachmentCount
Setting
Sets the number of attachments this blog post has.
Getting
Returns the number of attachments this blog post has.
blogID
Setting
Sets the blog ID this post belongs to.
Getting
Returns the blog ID this post belongs to.
body
Setting
Sets the body of this post. If body is larger than message.maxBodySize the body will be truncated.
Getting
commentCount
Setting
Sets the number of comments this blog post has.
Getting
Returns the number of comments this blog post has.
commentStatus
Setting
Sets the comment status of this blog post.
Getting
Returns the comment status of this blog post which may be any one of the following:
  • 1 (COMMENTS_NONE) -- no comments allowed
  • 2 (COMMENTS_OPEN) -- comments are permitted
  • 3 (COMMENTS_CLOSED) -- comments were permitted but are not allowed now
Defaults to 2 (COMMENTS_OPEN) .
creationDate
Setting
Sets the creation date of this post. In most cases, the creation date will default to when the post 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 post was created.
ID
Setting
Set the unique id of this object.
Getting
imageCount
Setting
Sets the number of images this blog post has.
Getting
Returns the number of images this blog post has.
modificationDate
Setting
Sets the date this post was last modified. In most cases, last modifed will default to when the post 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 this post was last modified.
nextPostID
Setting
Sets the next blogpost ID that has been published.
Getting
Returns the next blogpost ID that has been published.
objectType
Setting
Sets the object type of the jive object.
Getting
permalink
Setting
Sets the permalink for this blog post.
Getting
Returns the permalink for this post, where the permalink is a composed only of unreserved characters:

unreserved = ALPHA / DIGIT / "-" / "." / "_" / "~"

as according to RFC 3986: http://www.ietf.org/rfc/rfc3986.txt

Space characters and characters not in the list of unreserved characters are replaced with a hyphen character.

If an entry is composed entirely of spaces or characters not in the list of unreserved characters, the permalink will instead be the ID of the blog post from . Example: subject: New Stuff in Jive Jive SBS 3.0
permalink: new-stuff-in-jive-clearspace-3-0

plainBody
Setting
Sets the plain body.
Getting
Returns the plain body.
plainSubject
Setting
Sets the plain subject.
Getting
Returns the plain subject.
previousPostID
Setting
Sets the previous blogpost ID that has been published.
Getting
Returns the previous blogpost ID that has been published.
properties
Setting
Sets the properties associated with this blogpost.
Getting
Returns the properties associated with this blogpost.
publishDate
Setting
Sets the publish date of this post. In most cases, the publish date will be the date that the post was initially created. However, if the user chooses, he / she can provide a date in the future or in the past to allow for future publishing or post dating.
Getting
Returns that date that this post should be published.
status
Setting
Sets the publishing status of this blog post which may be any one of the following:
  • 1 (STATUS_DRAFT) -- post has status of unpublished
  • 2 (STATUS_PUBLISH) -- post has status of published
  • .
Getting
subject
Setting
Sets the subject of this blog post.
Getting
tags
Setting
Sets the tags associated with this blogpost.
Getting
Returns the tags associated with this blogpost.
trackbacksEnabled
Setting
Enables and disables trackbacks for this blog post. Default is true.
Getting
Returns true if trackbacks are accepted on this blog post, false if not. Default is true.
unfilteredSubject
Setting
Sets the unfiltered subject.
Getting
Returns the unfiltered subject.
user
Setting
Sets the id of the user.
Getting
Returns the ID User that authored this blogpost. If the blogpost was created anonymously, this method will return 0.