Thread Script API Type

Ben Tiedt — Fri, 08 Mar 2024 17:29:12 GMT

Current Revision posted to API Documentation by Ben Tiedt on 03/08/2024 17:29:12

Properties
AddPollItem
ClearPollItems
CompareTo
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
AnswerSuggestedByUserId	Read, Write	`Int32`	Answer Suggested By User Id
AnswerVerifiedByUserId	Read, Write	`Int32`	Answer Verified By User Id
ApiContentType	Read	`Nullable of Guid`	Api Content Type
ApplicationId	Read	`Guid`	Application Id
ApplicationType	Read	`[[ApplicationType Script API Type\|ApplicationType]]`	Application Type
ApplicationTypeId	Read	`Guid`	Application Type Id
Attachment	Read, Write	`[[IAttachment Script API Type\|IAttachment]]`	Attachment
AttachmentFilename	Read, Write	`String`	Attachment Filename
AttachmentKey	Read	`[[AttachmentKey Script API Type\|AttachmentKey]]`	Attachment Key
Body	Read, Write	`String`	Body
Categories	Read, Write	`Array of String`	Categories
ChildCount	Read, Write	`Nullable of Int32`	Child Count
Container	Read	`[[IContentContainer Script API Type\|IContentContainer]]`	Container
ContentID	Read, Write	`Guid`	Content I D
ContentTypeId	Read	`Int32`	Content Type Id
Date	Read	`DateTime`	Date
EditNotes	Read, Write	`String`	Edit Notes
EffectiveDepth	Read, Write	`Nullable of Int32`	Effective Depth
EmoticonID	Read, Write	`Int32`	Emoticon I D
Excerpt	Read, Write	`String`	Excerpt
ExtendedAttributesCount	Read	`Int32`	Extended Attributes Count
ExtendedAttributesKeys	Read	`Array of String`	Extended Attributes Keys
FeaturedImage	Read	`String`	Featured Image
ForceExcerpt	Read	`String`	Force Excerpt
FormattedBody	Read, Write	`String`	Formatted Body
Forum	Read, Write	`[[Forum Script API Type\|Forum]]`	Forum
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
HasPoll	Read, Write	`Boolean`	Obsolete. Property is no longer supported, use Poll API instead. Has Poll
HasRead	Read, Write	`Boolean`	Has Read
HasVideo	Read	`Boolean`	Has Video
IndexInThread	Read, Write	`Int32`	Index In Thread
InkID	Read, Write	`Int32`	Ink I D
IsAnnouncement	Read	`Boolean`	Is Announcement
IsAnonymousPost	Read, Write	`Boolean`	Is Anonymous Post
IsApproved	Read, Write	`Boolean`	Is Approved
IsDeleted	Read, Write	`Boolean`	Is Deleted
IsFeatured	Read	`Boolean`	Is Featured
IsHidden	Read, Write	`Boolean`	Is Hidden
IsIgnoredPost	Read, Write	`Boolean`	Is Ignored Post
IsIndexed	Read, Write	`Boolean`	Is Indexed
IsLocked	Read, Write	`Boolean`	Is Locked
IsPopular	Read	`Boolean`	Is Popular
IsReadOnly	Read	`Boolean`	Is Read Only
IsSticky	Read, Write	`Boolean`	Is Sticky
IsTracked	Read, Write	`Boolean`	Is Tracked
LastReadDate	Read	`DateTime`	Last Read Date
MostRecentPostAuthor	Read, Write	`String`	Most Recent Post Author
MostRecentPostAuthorID	Read, Write	`Int32`	Most Recent Post Author I D
MostRecentPostID	Read, Write	`Int32`	Most Recent Post I D
Name	Read, Write	`String`	Name
NextSiblingCount	Read, Write	`Nullable of Int32`	Next Sibling Count
NodeId	Read	`Guid`	Node Id
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
PostConfiguration	Read, Write	`[[PostConfiguration Script API Type\|PostConfiguration]]`	Post Configuration
PostDate	Read, Write	`DateTime`	Post Date
PostID	Read, Write	`Int32`	Post I D
PostLevel	Read, Write	`Int32`	Post Level
PostMedia	Read, Write	`[[PostMediaType Script API Type\|PostMediaType]]`	Post Media
PostStatus	Read, Write	`[[PostStatus Script API Type\|PostStatus]]`	Post Status
PostType	Read, Write	`[[PostContentType Script API Type\|PostContentType]]`	Post Type
PreviousSiblingCount	Read, Write	`Nullable of Int32`	Previous Sibling Count
QualityNoVotes	Read, Write	`Int32`	Quality No Votes
QualityScore	Read, Write	`Int32`	Quality Score
QualityYesVotes	Read, Write	`Int32`	Quality Yes Votes
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
RootReplyId	Read, Write	`Guid`	Root Reply Id
Section	Read, Write	`[[Section Script API Type\|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 Script API Type\|SpamStatus]]`	Spam Status
Status	Read, Write	`[[ThreadStatus Script API Type\|ThreadStatus]]`	Status
StickyDate	Read, Write	`DateTime`	Sticky Date
Stub	Read	`String`	Stub
Subject	Read, Write	`String`	Subject
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
ThreadShouldBeIgnored	Read	`Boolean`	Thread Should Be Ignored
ThreadStartDate	Read, Write	`DateTime`	Thread Start Date
ThreadType	Read, Write	`[[ThreadType Script API Type\|ThreadType]]`	Thread Type
TotalQualityVotes	Read, Write	`Int32`	Total Quality Votes
TotalRatings	Read, Write	`Int32`	Obsolete. This is no longer supported, use the Ratings API instead Total Ratings
TrackedCount	Read	`Int32`	Tracked Count
Uri	Read	`Uri`	Uri
User	Read	`[[User Script API Type\|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
ViewType	Read	`[[PostViewType Script API Type\|PostViewType]]`	View Type

Methods

AddPollItem

Velocity

$thread.AddPollItem($item)

JavaScript

thread.AddPollItem(item);

Parameters

Name	Type	Description	Required	Default	Options
item	`[[PollItem Script API Type\|PollItem]]`	Item	Required

Returns

Nothing

ClearPollItems

Velocity

$thread.ClearPollItems()

JavaScript

thread.ClearPollItems();

Returns

Nothing

CompareTo

Velocity

#set($int32Response = $thread.CompareTo($value))

JavaScript

var int32Response = thread.CompareTo(value);

Parameters

Name	Type	Description	Required	Default	Options
value	`Object`	Value	Required

Returns

Int32

ContentHtml

Velocity

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

JavaScript

var stringResponse = thread.ContentHtml(target);

Parameters

Name	Type	Description	Required	Default	Options
target	`[[PostTarget Script API Type\|PostTarget]]`	Target	Required

Returns

String

Copy

Copy Overload 1

Velocity

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

JavaScript

var objectResponse = thread.Copy();

Copy Overload 2

Velocity

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

JavaScript

var objectResponse = thread.Copy();

Returns

Object

CopyPollDataFrom

Velocity

$thread.CopyPollDataFrom($p)

JavaScript

thread.CopyPollDataFrom(p);

Parameters

Name	Type	Description	Required	Default	Options
p	`[[Post Script API Type\|Post]]`	P	Required

Returns

Nothing

GetBool

Velocity

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

JavaScript

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

JavaScript

var booleanResponse = thread.GetCurrentRelated(relatedObject);

Parameters

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

Returns

Boolean

GetDateTime

Velocity

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

JavaScript

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

JavaScript

var stringResponse = thread.GetExtendedAttribute(name);

Parameters

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

Returns

String

GetInt

Velocity

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

JavaScript

var int32Response = thread.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 = $thread.GetPollItems())

JavaScript

var listResponse = thread.GetPollItems();

Returns

List of [[PollItem Script API Type|PollItem]]

GetSerializedXml

Velocity

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

JavaScript

var stringResponse = thread.GetSerializedXml(asNameValueAttributes);

Parameters

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

Returns

String

GetSerializerData

Velocity

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

JavaScript

var serializerDataResponse = thread.GetSerializerData();

Returns

[[SerializerData Script API Type|SerializerData]]

GetString

Velocity

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

JavaScript

var stringResponse = thread.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 = $thread.RemovePollItem($item))

JavaScript

var pollItemResponse = thread.RemovePollItem(item);

Parameters

Name	Type	Description	Required	Default	Options
item	`[[PollItem Script API Type\|PollItem]]`	Item	Required

Returns

[[PollItem Script API Type|PollItem]]

RenderedBody

Velocity

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

JavaScript

var stringResponse = thread.RenderedBody(target);

Parameters

Name	Type	Description	Required	Default	Options
target	`[[PostTarget Script API Type\|PostTarget]]`	Target	Required

Returns

String

SetExtendedAttribute

Velocity

$thread.SetExtendedAttribute($name, $value)

JavaScript

thread.SetExtendedAttribute(name, value);

Parameters

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

Returns

Nothing

SetPostMedia

Velocity

$thread.SetPostMedia($pm, $isSelected)

JavaScript

thread.SetPostMedia(pm, isSelected);

Parameters

Name	Type	Description	Required	Default	Options
pm	`[[PostMediaType Script API Type\|PostMediaType]]`	Pm	Required
isSelected	`Boolean`	Is Selected	Required

Returns

Nothing

SetSerializedXml

Velocity

$thread.SetSerializedXml($xml)

JavaScript

thread.SetSerializedXml(xml);

Parameters

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

Returns

Nothing

SetSerializerData

Velocity

$thread.SetSerializerData($data)

JavaScript

thread.SetSerializerData(data);

Parameters

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

Returns

Nothing

SetSubjectRaw

Velocity

$thread.SetSubjectRaw($newSubject)

JavaScript

thread.SetSubjectRaw(newSubject);

Parameters

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

Returns

Nothing

TitleHtml

Velocity

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

JavaScript

var stringResponse = thread.TitleHtml(target);

Parameters

Name	Type	Description	Required	Default	Options
target	`[[PostTarget Script API Type\|PostTarget]]`	Target	Required

Returns

String

UpdatePollItem

Velocity

$thread.UpdatePollItem($item)

JavaScript

thread.UpdatePollItem(item);

Parameters

Name	Type	Description	Required	Default	Options
item	`[[PollItem Script API Type\|PollItem]]`	Item	Required

Returns

Nothing

ViewCount

Velocity

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

JavaScript

var int32Response = thread.ViewCount();

Returns

Int32