Weblog Script API Type

Former Member — Fri, 13 May 2022 19:29:20 GMT

Current Revision posted to API Documentation by Former Member on 05/13/2022 19:29:20

Properties
CanCreateContent
CanCreateLocalAttachment
CanCreateRemoteAttachment
CanReadContent
Clone
Copy
EnableNewComments
GetBool
GetCurrentRelated
GetDateTime
GetExtendedAttribute
GetInt
GetSerializedXml
GetSerializerData
GetString
IsOwner
SetExtendedAttribute
SetOwners
SetSerializedXml
SetSerializerData
ValidateRatings
ValidateTrackBacks

Properties

Name	Access	Type	Description
AboutDescription	Read, Write	`String`	About Description
AboutTitle	Read, Write	`String`	About Title
AboutTitleIsDefault	Read	`Boolean`	About Title Is Default
ApplicationId	Read	`Guid`	Application Id
ApplicationKey	Read, Write	`String`	Application Key
ApplicationType	Read, Write	`[[ApplicationType Script API Type\|ApplicationType]]`	Application Type
ApplicationTypeId	Read	`Guid`	Application Type Id
AutoNamePosts	Read, Write	`Boolean`	Auto Name Posts
BlockSpamFeedbackNotifications	Read, Write	`Boolean`	Block Spam Feedback Notifications
CategorySortBy	Read, Write	`[[PostCategorySortBy Script API Type\|PostCategorySortBy]]`	Obsolete. This is no longer used and will always return PostCategorySortBy.Name. Category Sort By
CategorySortOrder	Read, Write	`[[SortOrder Script API Type\|SortOrder]]`	Obsolete. This is no longer used and will always return SortOrder.Ascending. Category Sort Order
CommentCount	Read, Write	`Int32`	Comment Count
CommentExpirationDays	Read, Write	`Int32`	Comment Expiration Days
CreatedByUserId	Read, Write	`Nullable of Int32`	Created By User Id
DateCreated	Read, Write	`DateTime`	Date Created
DefaultPostConfig	Read	`[[BlogPostConfig Script API Type\|BlogPostConfig]]`	Default Post Config
DefaultPostImageUrl	Read, Write	`String`	Default Post Image Url
DefaultThreadDateFilter	Read, Write	`[[ThreadDateFilterMode Script API Type\|ThreadDateFilterMode]]`	Obsolete. This is no longer used and will always return ThreadDateFilterMode.TwoMonths. Default Thread Date Filter
Description	Read, Write	`String`	Description
DiskUsage	Read, Write	`Int64`	Disk Usage
DisplayMask	Read, Write	`Array of Byte`	Obsolete. This is no longer used and will always return null. Display Mask
Email	Read, Write	`String`	Email
EnableAbout	Read, Write	`Boolean`	Enable About
EnableAggBugs	Read, Write	`Boolean`	Enable Agg Bugs
EnableAllOwnerNotification	Read, Write	`Boolean`	Enable All Owner Notification
EnableAnonymousPostingForUsers	Read, Write	`Boolean`	Obsolete. This is no longer used and will always return false. Use forum permissions instead. Enable Anonymous Posting For Users
EnableAtom	Read, Write	`Boolean`	Enable Atom
EnableCommentsDefault	Read, Write	`Boolean`	Enable Comments Default
EnableCommentsOverride	Read, Write	`Boolean`	Enable Comments Override
EnableCommunityParticipationDefault	Read, Write	`Boolean`	Enable Community Participation Default
EnableContact	Read, Write	`Boolean`	Enable Contact
EnableITunes	Read, Write	`Boolean`	Enable I Tunes
EnablePings	Read, Write	`Boolean`	Enable Pings
EnablePostAggregationDefault	Read, Write	`Boolean`	Enable Post Aggregation Default
EnablePostStatistics	Read, Write	`Boolean`	Enable Post Statistics
EnableRatingsDefault	Read, Write	`Boolean`	Enable Ratings Default
EnableRatingsOverride	Read, Write	`Boolean`	Enable Ratings Override
EnableRss	Read, Write	`Boolean`	Enable Rss
EnableRssCommentFeedsOverride	Read, Write	`Boolean`	Enable Rss Comment Feeds Override
EnableTagsRss	Read, Write	`Boolean`	Enable Tags Rss
EnableTrackbacksDefault	Read, Write	`Boolean`	Enable Trackbacks Default
EnableTrackbacksOverride	Read, Write	`Boolean`	Enable Trackbacks Override
ExcludeOwnerFromFeedBurnerStatistics	Read, Write	`Boolean`	Exclude Owner From Feed Burner Statistics
ExtendedAttributesCount	Read	`Int32`	Extended Attributes Count
ExtendedAttributesKeys	Read	`Array of String`	Extended Attributes Keys
ExternalFeedUrl	Read, Write	`String`	External Feed Url
FeedbackNotificationType	Read, Write	`[[FeedbackNotificationType Script API Type\|FeedbackNotificationType]]`	Feedback Notification Type
FeedBurnerUserName	Read, Write	`String`	Feed Burner User Name
ForumType	Read, Write	`[[ForumType Script API Type\|ForumType]]`	Forum Type
Group	Read	`[[Group Script API Type\|Group]]`	Group
GroupID	Read, Write	`Int32`	Group I D
GroupName	Read	`String`	Group Name
HasChildSections	Read	`Boolean`	Obsolete. This is no longer used and will always return false. Has Child Sections
HasChildSectionsLoaded	Read	`Boolean`	Obsolete. This is no longer used and will always return true. Has Child Sections Loaded
IsActive	Read, Write	`Boolean`	Is Active
IsAnnouncement	Read	`Boolean`	Obsolete. This is no longer used and will always return false. Is Announcement
IsCommunityAggregated	Read, Write	`Boolean`	Is Community Aggregated
IsFeedBurnerStatsEnabled	Read	`Boolean`	Is Feed Burner Stats Enabled
IsIncludedInSitemap	Read, Write	`Boolean`	Is Included In Sitemap
IsIndexed	Read, Write	`Boolean`	Is Indexed
IsModerated	Read, Write	`Boolean`	Is Moderated
IsPrivate	Read	`Boolean`	Is Private
IsVisible	Read, Write	`Boolean`	Obsolete. This is no longer used and will always return true. Is Visible
ITunesCategory	Read, Write	`String`	I Tunes Category
ITunesExplicit	Read, Write	`String`	I Tunes Explicit
ITunesImageUrl	Read, Write	`String`	I Tunes Image Url
ITunesKeywords	Read, Write	`String`	I Tunes Keywords
ITunesOwnerEmail	Read, Write	`String`	I Tunes Owner Email
ITunesOwnerName	Read, Write	`String`	I Tunes Owner Name
ITunesSubTitle	Read, Write	`String`	I Tunes Sub Title
MetaTagDescription	Read, Write	`String`	Meta Tag Description
MetaTagKeywords	Read, Write	`String`	Meta Tag Keywords
ModerationTypeDefault	Read	`[[CommentModerationType Script API Type\|CommentModerationType]]`	Moderation Type Default
ModerationTypeOverride	Read, Write	`[[CommentModerationType Script API Type\|CommentModerationType]]`	Moderation Type Override
MostRecentPostAuthor	Read, Write	`String`	Most Recent Post Author
MostRecentPostAuthorID	Read, Write	`Int32`	Most Recent Post Author I D
MostRecentPostDate	Read, Write	`DateTime`	Most Recent Post Date
MostRecentPostID	Read, Write	`Int32`	Most Recent Post I D
MostRecentPostName	Read, Write	`String`	Most Recent Post Name
MostRecentPostSubject	Read, Write	`String`	Most Recent Post Subject
MostRecentThreadID	Read, Write	`Int32`	Most Recent Thread I D
MostRecentThreadReplies	Read, Write	`Int32`	Most Recent Thread Replies
Name	Read, Write	`String`	Name
NeedsSearchReindexing	Read	`Boolean`	Needs Search Reindexing
NewsgroupName	Read, Write	`String`	Obsolete. This is no longer used and will always return string.Empty. Newsgroup Name
NodeId	Read, Write	`Guid`	Node Id
Owners	Read	`Array of [[User Script API Type\|User]]`	Owners
ParentID	Read, Write	`Int32`	Parent I D
PingUrls	Read, Write	`Array of String`	Ping Urls
PostCount	Read, Write	`Int32`	Post Count
PostSummaryLengthDefault	Read, Write	`Int32`	Post Summary Length Default
RawAdditionalHeader	Read, Write	`String`	Raw Additional Header
SectionID	Read, Write	`Int32`	Section I D
Sections	Read, Write	`List of [[Section Script API Type\|Section]]`	Obsolete. This is no longer used and will always return an empty list. Sections
SettingsID	Read, Write	`Int32`	Settings I D
ShowContact	Read	`Boolean`	Show Contact
SortOrder	Read, Write	`Int32`	Sort Order
SyndicateExcerptDefault	Read, Write	`Boolean`	Syndicate Excerpt Default
SyndicateExternalLinks	Read, Write	`Boolean`	Syndicate External Links
ThemeId	Read, Write	`Guid`	Theme Id
ThemeIsDefault	Read	`Boolean`	Theme Is Default
TotalPosts	Read, Write	`Int32`	Total Posts
TotalThreads	Read, Write	`Int32`	Total Threads
TrackbackCount	Read, Write	`Int32`	Trackback Count
Url	Read	`String`	Url

Methods

CanCreateContent

Velocity

#set($booleanResponse = $weblog.CanCreateContent($user))

JavaScript

var booleanResponse = weblog.CanCreateContent(user);

Parameters

Name	Type	Description	Required	Default	Options
user	`[[User Script API Type\|User]]`	User	Required

Returns

Boolean

CanCreateLocalAttachment

Velocity

#set($booleanResponse = $weblog.CanCreateLocalAttachment($user))

JavaScript

var booleanResponse = weblog.CanCreateLocalAttachment(user);

Parameters

Name	Type	Description	Required	Default	Options
user	`[[User Script API Type\|User]]`	User	Required

Returns

Boolean

CanCreateRemoteAttachment

Velocity

#set($booleanResponse = $weblog.CanCreateRemoteAttachment($user))

JavaScript

var booleanResponse = weblog.CanCreateRemoteAttachment(user);

Parameters

Name	Type	Description	Required	Default	Options
user	`[[User Script API Type\|User]]`	User	Required

Returns

Boolean

CanReadContent

Velocity

#set($booleanResponse = $weblog.CanReadContent($user))

JavaScript

var booleanResponse = weblog.CanReadContent(user);

Parameters

Name	Type	Description	Required	Default	Options
user	`[[User Script API Type\|User]]`	User	Required

Returns

Boolean

Clone

Velocity

#set($objectResponse = $weblog.Clone())

JavaScript

var objectResponse = weblog.Clone();

Returns

Object

Copy

Copy Overload 1

Velocity

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

JavaScript

var objectResponse = weblog.Copy();

Copy Overload 2

Velocity

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

JavaScript

var objectResponse = weblog.Copy();

Returns

Object

EnableNewComments

Velocity

#set($booleanResponse = $weblog.EnableNewComments($post, $user))

JavaScript

var booleanResponse = weblog.EnableNewComments(post, user);

Parameters

Name	Type	Description	Required	Default	Options
post	`[[WeblogPost Script API Type\|WeblogPost]]`	Post	Required
user	`[[User Script API Type\|User]]`	User	Required

Returns

Boolean

GetBool

Velocity

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

JavaScript

var booleanResponse = weblog.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 = $weblog.GetCurrentRelated($relatedObject))

JavaScript

var booleanResponse = weblog.GetCurrentRelated(relatedObject);

Parameters

Name	Type	Description	Required	Default	Options
relatedObject	`[[T& Script API Type\|T&]]`	Related Object	Required

Returns

Boolean

GetDateTime

Velocity

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

JavaScript

var dateTimeResponse = weblog.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 = $weblog.GetExtendedAttribute($name))

JavaScript

var stringResponse = weblog.GetExtendedAttribute(name);

Parameters

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

Returns

String

GetInt

Velocity

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

JavaScript

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

Parameters

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

Returns

Int32

GetSerializedXml

Velocity

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

JavaScript

var stringResponse = weblog.GetSerializedXml(asNameValueAttributes);

Parameters

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

Returns

String

GetSerializerData

Velocity

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

JavaScript

var serializerDataResponse = weblog.GetSerializerData();

Returns

[[SerializerData Script API Type|SerializerData]]

GetString

Velocity

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

JavaScript

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

Parameters

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

Returns

String

IsOwner

IsOwner Overload 1

Velocity

#set($booleanResponse = $weblog.IsOwner($userid))

JavaScript

var booleanResponse = weblog.IsOwner(userid);

Parameters

Name	Type	Description	Required	Default	Options
userid	`Int32`	Userid	Required

IsOwner Overload 2

Velocity

#set($booleanResponse = $weblog.IsOwner($user))

JavaScript

var booleanResponse = weblog.IsOwner(user);

Parameters

Name	Type	Description	Required	Default	Options
user	`[[User Script API Type\|User]]`	User	Required

IsOwner Overload 3

Velocity

#set($booleanResponse = $weblog.IsOwner($userName))

JavaScript

var booleanResponse = weblog.IsOwner(userName);

Parameters

Name	Type	Description	Required	Default	Options
userName	`String`	User Name	Required

Returns

Boolean

SetExtendedAttribute

Velocity

$weblog.SetExtendedAttribute($name, $value)

JavaScript

weblog.SetExtendedAttribute(name, value);

Parameters

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

Returns

Nothing

SetOwners

SetOwners Overload 1

Velocity

$weblog.SetOwners($users)

JavaScript

weblog.SetOwners(users);

Parameters

Name	Type	Description	Required	Default	Options
users	`Array of [[User Script API Type\|User]]`	Users	Required

SetOwners Overload 2

Velocity

$weblog.SetOwners($users)

JavaScript

weblog.SetOwners(users);

Parameters

Name	Type	Description	Required	Default	Options
users	`IEnumerable of [[User Script API Type\|User]]`	Users	Required

Returns

Nothing

SetSerializedXml

Velocity

$weblog.SetSerializedXml($xml)

JavaScript

weblog.SetSerializedXml(xml);

Parameters

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

Returns

Nothing

SetSerializerData

Velocity

$weblog.SetSerializerData($data)

JavaScript

weblog.SetSerializerData(data);

Parameters

Name	Type	Description	Required	Default	Options
data	`[[SerializerData Script API Type\|SerializerData]]`	Data	Required

Returns

Nothing

ValidateRatings

Velocity

#set($booleanResponse = $weblog.ValidateRatings($post))

JavaScript

var booleanResponse = weblog.ValidateRatings(post);

Parameters

Name	Type	Description	Required	Default	Options
post	`[[WeblogPost Script API Type\|WeblogPost]]`	Post	Required

Returns

Boolean

ValidateTrackBacks

Velocity

#set($booleanResponse = $weblog.ValidateTrackBacks($post))

JavaScript

var booleanResponse = weblog.ValidateTrackBacks(post);

Parameters

Name	Type	Description	Required	Default	Options
post	`[[WeblogPost Script API Type\|WeblogPost]]`	Post	Required

Returns

Boolean