Section Script API Type

Ben Tiedt — Fri, 08 Mar 2024 17:28:57 GMT

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

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

Properties

Name	Access	Type	Description
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
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
CreatedByUserId	Read, Write	`Nullable of Int32`	Created By User Id
DateCreated	Read, Write	`DateTime`	Date Created
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
EnableAnonymousPostingForUsers	Read, Write	`Boolean`	Obsolete. This is no longer used and will always return false. Use forum permissions instead. Enable Anonymous Posting For Users
EnablePostStatistics	Read, Write	`Boolean`	Enable Post Statistics
ExtendedAttributesCount	Read	`Int32`	Extended Attributes Count
ExtendedAttributesKeys	Read	`Array of String`	Extended Attributes Keys
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
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
MetaTagDescription	Read, Write	`String`	Meta Tag Description
MetaTagKeywords	Read, Write	`String`	Meta Tag Keywords
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
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, Write	`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
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
SortOrder	Read, Write	`Int32`	Sort Order
TotalPosts	Read, Write	`Int32`	Total Posts
TotalThreads	Read, Write	`Int32`	Total Threads
Url	Read	`String`	Url

Methods

CanCreateContent

Velocity

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

JavaScript

var booleanResponse = section.CanCreateContent(user);

Parameters

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

Returns

Boolean

CanCreateLocalAttachment

Velocity

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

JavaScript

var booleanResponse = section.CanCreateLocalAttachment(user);

Parameters

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

Returns

Boolean

CanCreateRemoteAttachment

Velocity

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

JavaScript

var booleanResponse = section.CanCreateRemoteAttachment(user);

Parameters

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

Returns

Boolean

CanReadContent

Velocity

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

JavaScript

var booleanResponse = section.CanReadContent(user);

Parameters

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

Returns

Boolean

Copy

Copy Overload 1

Velocity

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

JavaScript

var objectResponse = section.Copy();

Copy Overload 2

Velocity

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

JavaScript

var objectResponse = section.Copy();

Returns

Object

GetBool

Velocity

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

JavaScript

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

JavaScript

var booleanResponse = section.GetCurrentRelated(relatedObject);

Parameters

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

Returns

Boolean

GetDateTime

Velocity

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

JavaScript

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

JavaScript

var stringResponse = section.GetExtendedAttribute(name);

Parameters

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

Returns

String

GetInt

Velocity

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

JavaScript

var int32Response = section.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 = $section.GetSerializedXml($asNameValueAttributes))

JavaScript

var stringResponse = section.GetSerializedXml(asNameValueAttributes);

Parameters

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

Returns

String

GetSerializerData

Velocity

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

JavaScript

var serializerDataResponse = section.GetSerializerData();

Returns

[[SerializerData Script API Type|SerializerData]]

GetString

Velocity

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

JavaScript

var stringResponse = section.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 = $section.IsOwner($userid))

JavaScript

var booleanResponse = section.IsOwner(userid);

Parameters

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

IsOwner Overload 2

Velocity

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

JavaScript

var booleanResponse = section.IsOwner(user);

Parameters

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

IsOwner Overload 3

Velocity

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

JavaScript

var booleanResponse = section.IsOwner(userName);

Parameters

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

Returns

Boolean

SetExtendedAttribute

Velocity

$section.SetExtendedAttribute($name, $value)

JavaScript

section.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

$section.SetOwners($users)

JavaScript

section.SetOwners(users);

Parameters

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

SetOwners Overload 2

Velocity

$section.SetOwners($users)

JavaScript

section.SetOwners(users);

Parameters

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

Returns

Nothing

SetSerializedXml

Velocity

$section.SetSerializedXml($xml)

JavaScript

section.SetSerializedXml(xml);

Parameters

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

Returns

Nothing

SetSerializerData

Velocity

$section.SetSerializerData($data)

JavaScript

section.SetSerializerData(data);

Parameters

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

Returns

Nothing