WeblogPost Script API Type

Properties
AddPollItem
ClearPollItems
ContentHtml
Copy
CopyPollDataFrom
GetBool
GetCurrentRelated
GetDateTime
GetExtendedAttribute
GetInt
GetPollItems
GetSerializedXml
GetSerializerData
GetString
RemovePollItem
RenderedBody
SetExtendedAttribute
SetPostMedia
SetSerializedXml
SetSerializerData
SetSubjectRaw
TitleHtml
UpdatePollItem
ViewCount

Properties

Name	Access	Type	Description
ApiContentType	Read	`Nullable of Guid`	Api Content Type
ApplicationId	Read	`Guid`	Application Id
ApplicationType	Read	`ApplicationType`	Application Type
ApplicationTypeId	Read	`Guid`	Application Type Id
Attachment	Read, Write	`IAttachment`	Attachment
AttachmentFilename	Read, Write	`String`	Attachment Filename
AttachmentKey	Read	`AttachmentKey`	Attachment Key
AuthorID	Read, Write	`Int32`	Author I D
BlogPostTypeName	Read	`String`	Blog Post Type Name
Body	Read, Write	`String`	Body
Categories	Read, Write	`Array of String`	Categories
Container	Read	`IContentContainer`	Container
ContentID	Read, Write	`Guid`	Content I D
ContentTypeId	Read	`Int32`	Content Type Id
CreatedUserId	Read, Write	`Int32`	Created User Id
CurrentUserTime	Read	`DateTime`	Current User Time
Date	Read	`DateTime`	Date
DisplayExcerpt	Read, Write	`Boolean`	Display Excerpt
DisplayName	Read	`String`	Display Name
EditNotes	Read, Write	`String`	Edit Notes
EmoticonID	Read, Write	`Int32`	Emoticon I D
EnableAllOwnerNotification	Read, Write	`Boolean`	Enable All Owner Notification
EnableRatings	Read, Write	`Boolean`	Enable Ratings
EnableTrackBacks	Read, Write	`Boolean`	Enable Track Backs
EnableXmlRpcPings	Read, Write	`Boolean`	Enable Xml Rpc Pings
EverTracked	Read, Write	`Boolean`	Ever Tracked
Excerpt	Read, Write	`String`	Excerpt
ExcerptSize	Read, Write	`Int32`	Excerpt Size
ExtendedAttributesCount	Read	`Int32`	Extended Attributes Count
ExtendedAttributesKeys	Read	`Array of String`	Extended Attributes Keys
FeaturedImage	Read	`String`	Featured Image
FeedbackNotificationType	Read, Write	`FeedbackNotificationType`	Feedback Notification Type
ForceExcerpt	Read	`String`	Force Excerpt
FormattedBody	Read, Write	`String`	Formatted Body
HasAttachment	Read	`Boolean`	Has Attachment
HasCategories	Read	`Boolean`	Has Categories
HasExcerpt	Read	`Boolean`	Has Excerpt
HasInk	Read	`Boolean`	Has Ink
HasName	Read	`Boolean`	Has Name
HasPendingChanges	Read, Write	`Boolean`	Has Pending Changes
HasPoll	Read, Write	`Boolean`	Obsolete. Property is no longer supported, use Poll API instead. Has Poll
HasRead	Read, Write	`Boolean`	Has Read
HasSubmittedUserName	Read	`Boolean`	Has Submitted User Name
HasTitleUrl	Read	`Boolean`	Has Title Url
HasVideo	Read	`Boolean`	Has Video
IndexInThread	Read, Write	`Int32`	Index In Thread
InkID	Read, Write	`Int32`	Ink I D
IsAggregated	Read, Write	`Boolean`	Is Aggregated
IsApproved	Read, Write	`Boolean`	Is Approved
IsCommunityAggregated	Read, Write	`Boolean`	Is Community Aggregated
IsExternal	Read, Write	`Boolean`	Is External
IsFeatured	Read	`Boolean`	Is Featured
IsHidden	Read, Write	`Boolean`	Is Hidden
IsIndexed	Read, Write	`Boolean`	Is Indexed
IsLocked	Read, Write	`Boolean`	Is Locked
IsPostEnabled	Read	`Boolean`	Is Post Enabled
IsReadOnly	Read	`Boolean`	Is Read Only
IsReviewPlaceholder	Read, Write	`Boolean`	Is Review Placeholder
IsTracked	Read, Write	`Boolean`	Is Tracked
LastReadDate	Read, Write	`DateTime`	Last Read Date
MetaDescription	Read, Write	`String`	Meta Description
MetaKeywords	Read, Write	`String`	Meta Keywords
MetaTitle	Read, Write	`String`	Meta Title
ModerationType	Read, Write	`CommentModerationType`	Moderation Type
Name	Read, Write	`String`	Name
NodeId	Read	`Guid`	Node Id
OpenGraphDescription	Read, Write	`String`	Open Graph Description
OpenGraphImageUrl	Read, Write	`String`	Open Graph Image Url
OpenGraphTitle	Read, Write	`String`	Open Graph Title
ParentID	Read, Write	`Int32`	Parent I D
Points	Read, Write	`Int32`	Points
PollDescription	Read, Write	`String`	Obsolete. Property is no longer supported, use Poll API instead. Poll Description
PollExpirationDate	Read, Write	`DateTime`	Obsolete. Property is no longer supported, use Poll API instead. Poll Expiration Date
PollItemIndexes	Read, Write	`String`	Obsolete. Property is no longer supported, use Poll API instead. Poll Item Indexes
PollTitle	Read, Write	`String`	Obsolete. Property is no longer supported, use Poll API instead. Poll Title
PostConfig	Read, Write	`BlogPostConfig`	Post Config
PostDate	Read, Write	`DateTime`	Post Date
PostID	Read, Write	`Int32`	Post I D
PostImageAlternateText	Read, Write	`String`	Post Image Alternate Text
PostImageUrl	Read, Write	`String`	Post Image Url
PostLevel	Read, Write	`Int32`	Post Level
PostMedia	Read, Write	`PostMediaType`	Post Media
PostStatus	Read, Write	`PostStatus`	Post Status
PostType	Read, Write	`PostContentType`	Post Type
RatingAverage	Read	`Double`	Obsolete. This is no longer supported, use the Ratings API instead Rating Average
Ratings	Read	`IList`	Obsolete. This is no longer supported, use the Ratings API instead Ratings
RatingSum	Read, Write	`Int32`	Obsolete. This is no longer supported, use the Ratings API instead Rating Sum
Replies	Read, Write	`Int32`	Replies
Section	Read, Write	`Section`	Section
SectionID	Read, Write	`Int32`	Section I D
SortOrder	Read, Write	`Int32`	Sort Order
SpamScore	Read, Write	`Int32`	Spam Score
SpamStatus	Read, Write	`SpamStatus`	Spam Status
Stub	Read	`String`	Stub
Subject	Read, Write	`String`	Subject
SubmittedUserName	Read, Write	`String`	Submitted User Name
SyndicateExcerpt	Read, Write	`Boolean`	Syndicate Excerpt
ThreadDate	Read, Write	`DateTime`	Thread Date
ThreadID	Read, Write	`Int32`	Thread I D
ThreadIDNext	Read, Write	`Int32`	Thread I D Next
ThreadIDPrev	Read, Write	`Int32`	Thread I D Prev
TitleUrl	Read, Write	`String`	Title Url
TotalRatings	Read, Write	`Int32`	Obsolete. This is no longer supported, use the Ratings API instead Total Ratings
TrackBackName	Read, Write	`String`	Track Back Name
Uri	Read	`Uri`	Uri
UseCustomPostSummary	Read, Write	`Boolean`	Use Custom Post Summary
User	Read	`User`	User
UserHostAddress	Read, Write	`String`	User Host Address
UserID	Read, Write	`Int32`	User I D
UserTime	Read, Write	`DateTime`	User Time
VideoContentType	Read	`String`	Video Content Type
VideoDuration	Read, Write	`String`	Video Duration
VideoFileFormat	Read	`String`	Video File Format
VideoHeight	Read, Write	`Int32`	Video Height
VideoImageUrl	Read, Write	`String`	Video Image Url
VideoUrl	Read, Write	`String`	Video Url
VideoWidth	Read, Write	`Int32`	Video Width
ViewPostURL	Read	`String`	View Post U R L
Weblog	Read	`Weblog`	Weblog

Methods

AddPollItem

Velocity

$weblogPost.AddPollItem($item)

JavaScript

weblogPost.AddPollItem(item);

Parameters

Name	Type	Description	Required	Default	Options
item	`PollItem`	Item	Required

Returns

Nothing

ClearPollItems

Velocity

$weblogPost.ClearPollItems()

JavaScript

weblogPost.ClearPollItems();

Returns

Nothing

ContentHtml

Velocity

#set($stringResponse = $weblogPost.ContentHtml($target))

JavaScript

var stringResponse = weblogPost.ContentHtml(target);

Parameters

Name	Type	Description	Required	Default	Options
target	`PostTarget`	Target	Required

Returns

String

Copy

Copy Overload 1

Velocity

#set($objectResponse = $weblogPost.Copy())

JavaScript

var objectResponse = weblogPost.Copy();

Copy Overload 2

Velocity

#set($objectResponse = $weblogPost.Copy())

JavaScript

var objectResponse = weblogPost.Copy();

Returns

Object

CopyPollDataFrom

Velocity

$weblogPost.CopyPollDataFrom($p)

JavaScript

weblogPost.CopyPollDataFrom(p);

Parameters

Name	Type	Description	Required	Default	Options
p	`Post`	P	Required

Returns

Nothing

GetBool

Velocity

#set($booleanResponse = $weblogPost.GetBool($name, $defaultValue))

JavaScript

var booleanResponse = weblogPost.GetBool(name, defaultValue);

Parameters

Name	Type	Description	Required	Default	Options
name	`String`	Name	Required
defaultValue	`Boolean`	Default Value	Required

Returns

Boolean

GetCurrentRelated

Velocity

#set($booleanResponse = $weblogPost.GetCurrentRelated($relatedObject))

JavaScript

var booleanResponse = weblogPost.GetCurrentRelated(relatedObject);

Parameters

Name	Type	Description	Required	Default	Options
relatedObject	`T&`	Related Object	Required

Returns

Boolean

GetDateTime

Velocity

#set($dateTimeResponse = $weblogPost.GetDateTime($name, $defaultValue))

JavaScript

var dateTimeResponse = weblogPost.GetDateTime(name, defaultValue);

Parameters

Name	Type	Description	Required	Default	Options
name	`String`	Name	Required
defaultValue	`DateTime`	Default Value	Required

Returns

DateTime

GetExtendedAttribute

Velocity

#set($stringResponse = $weblogPost.GetExtendedAttribute($name))

JavaScript

var stringResponse = weblogPost.GetExtendedAttribute(name);

Parameters

Name	Type	Description	Required	Default	Options
name	`String`	Name	Required

Returns

String

GetInt

Velocity

#set($int32Response = $weblogPost.GetInt($name, $defaultValue))

JavaScript

var int32Response = weblogPost.GetInt(name, defaultValue);

Parameters

Name	Type	Description	Required	Default	Options
name	`String`	Name	Required
defaultValue	`Int32`	Default Value	Required

Returns

Int32

GetPollItems

Velocity

#set($listResponse = $weblogPost.GetPollItems())

JavaScript

var listResponse = weblogPost.GetPollItems();

Returns

List of PollItem

GetSerializedXml

Velocity

#set($stringResponse = $weblogPost.GetSerializedXml($asNameValueAttributes))

JavaScript

var stringResponse = weblogPost.GetSerializedXml(asNameValueAttributes);

Parameters

Name	Type	Description	Required	Default	Options
asNameValueAttributes	`Boolean`	As Name Value Attributes	Required

Returns

String

GetSerializerData

Velocity

#set($serializerDataResponse = $weblogPost.GetSerializerData())

JavaScript

var serializerDataResponse = weblogPost.GetSerializerData();

Returns

SerializerData

GetString

Velocity

#set($stringResponse = $weblogPost.GetString($name, $defaultValue))

JavaScript

var stringResponse = weblogPost.GetString(name, defaultValue);

Parameters

Name	Type	Description	Required	Default	Options
name	`String`	Name	Required
defaultValue	`String`	Default Value	Required

Returns

String

RemovePollItem

Velocity

#set($pollItemResponse = $weblogPost.RemovePollItem($item))

JavaScript

var pollItemResponse = weblogPost.RemovePollItem(item);

Parameters

Name	Type	Description	Required	Default	Options
item	`PollItem`	Item	Required

Returns

PollItem

RenderedBody

Velocity

#set($stringResponse = $weblogPost.RenderedBody($target))

JavaScript

var stringResponse = weblogPost.RenderedBody(target);

Parameters

Name	Type	Description	Required	Default	Options
target	`PostTarget`	Target	Required

Returns

String

SetExtendedAttribute

Velocity

$weblogPost.SetExtendedAttribute($name, $value)

JavaScript

weblogPost.SetExtendedAttribute(name, value);

Parameters

Name	Type	Description	Required	Default	Options
name	`String`	Name	Required
value	`String`	Value	Required

Returns

Nothing

SetPostMedia

Velocity

$weblogPost.SetPostMedia($pm, $isSelected)

JavaScript

weblogPost.SetPostMedia(pm, isSelected);

Parameters

Name	Type	Description	Required	Default	Options
pm	`PostMediaType`	Pm	Required
isSelected	`Boolean`	Is Selected	Required

Returns

Nothing

SetSerializedXml

Velocity

$weblogPost.SetSerializedXml($xml)

JavaScript

weblogPost.SetSerializedXml(xml);

Parameters

Name	Type	Description	Required	Default	Options
xml	`String`	Xml	Required

Returns

Nothing

SetSerializerData

Velocity

$weblogPost.SetSerializerData($data)

JavaScript

weblogPost.SetSerializerData(data);

Parameters

Name	Type	Description	Required	Default	Options
data	`SerializerData`	Data	Required

Returns

Nothing

SetSubjectRaw

Velocity

$weblogPost.SetSubjectRaw($newSubject)

JavaScript

weblogPost.SetSubjectRaw(newSubject);

Parameters

Name	Type	Description	Required	Default	Options
newSubject	`String`	New Subject	Required

Returns

Nothing

TitleHtml

Velocity

#set($stringResponse = $weblogPost.TitleHtml($target))

JavaScript

var stringResponse = weblogPost.TitleHtml(target);

Parameters

Name	Type	Description	Required	Default	Options
target	`PostTarget`	Target	Required

Returns

String

UpdatePollItem

Velocity

$weblogPost.UpdatePollItem($item)

JavaScript

weblogPost.UpdatePollItem(item);

Parameters

Name	Type	Description	Required	Default	Options
item	`PollItem`	Item	Required

Returns

Nothing

ViewCount

Velocity

#set($int32Response = $weblogPost.ViewCount())

JavaScript

var int32Response = weblogPost.ViewCount();

Returns

Int32

Recommended