MediaGallery Script API Type

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

Properties

Name	Access	Type	Description
AllowedFileExtensions	Read, Write	`String`	Allowed File Extensions
ApplicationId	Read	`Guid`	Application Id
ApplicationKey	Read, Write	`String`	Application Key
ApplicationType	Read, Write	`ApplicationType`	Application Type
ApplicationTypeId	Read	`Guid`	Application Type Id
BlockSpamFeedbackNotifications	Read, Write	`Boolean`	Block Spam Feedback Notifications
CategorySortBy	Read, Write	`PostCategorySortBy`	Obsolete. This is no longer used and will always return PostCategorySortBy.Name. Category Sort By
CategorySortOrder	Read, Write	`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`	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
EditUri	Read	`Uri`	Edit Uri
EnableAnonymousPostingForUsers	Read, Write	`Boolean`	Obsolete. This is no longer used and will always return false. Use forum permissions instead. Enable Anonymous Posting For Users
EnableCommentNotification	Read, Write	`Boolean`	Enable Comment Notification
EnableComments	Read, Write	`Boolean`	Enable Comments
EnableDisclaimer	Read, Write	`Boolean`	Enable Disclaimer
EnableExternalLinks	Read, Write	`Boolean`	Enable External Links
EnableMediaGalleryPostNotification	Read, Write	`Boolean`	Enable Media Gallery Post Notification
EnablePostStatistics	Read, Write	`Boolean`	Enable Post Statistics
EnableRatings	Read, Write	`Boolean`	Enable Ratings
EnableRssSyndication	Read, Write	`Boolean`	Enable Rss Syndication
EnableTagsRss	Read, Write	`Boolean`	Enable Tags Rss
ExtendedAttributesCount	Read	`Int32`	Extended Attributes Count
ExtendedAttributesKeys	Read	`Array of String`	Extended Attributes Keys
ForumType	Read, Write	`ForumType`	Forum Type
Group	Read	`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
ModerateComments	Read, Write	`Boolean`	Moderate Comments
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	`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
OrderNumber	Read	`Int32`	Order Number
Owners	Read	`Array of User`	Owners
ParentID	Read, Write	`Int32`	Parent I D
RestrictedFileExtensions	Read, Write	`String`	Restricted File Extensions
SectionID	Read, Write	`Int32`	Section I D
Sections	Read, Write	`List of 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
ViewType	Read, Write	`String`	View Type

Methods

CanCreateContent

Velocity

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

JavaScript

var booleanResponse = mediaGallery.CanCreateContent(user);

Parameters

Name	Type	Description	Required	Default	Options
user	`User`	User	Required

Returns

Boolean

CanCreateLocalAttachment

Velocity

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

JavaScript

var booleanResponse = mediaGallery.CanCreateLocalAttachment(user);

Parameters

Name	Type	Description	Required	Default	Options
user	`User`	User	Required

Returns

Boolean

CanCreateRemoteAttachment

Velocity

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

JavaScript

var booleanResponse = mediaGallery.CanCreateRemoteAttachment(user);

Parameters

Name	Type	Description	Required	Default	Options
user	`User`	User	Required

Returns

Boolean

CanReadContent

Velocity

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

JavaScript

var booleanResponse = mediaGallery.CanReadContent(user);

Parameters

Name	Type	Description	Required	Default	Options
user	`User`	User	Required

Returns

Boolean

Clone

Velocity

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

JavaScript

var objectResponse = mediaGallery.Clone();

Returns

Object

Copy

Copy Overload 1

Velocity

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

JavaScript

var objectResponse = mediaGallery.Copy();

Copy Overload 2

Velocity

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

JavaScript

var objectResponse = mediaGallery.Copy();

Returns

Object

GetBool

Velocity

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

JavaScript

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

JavaScript

var booleanResponse = mediaGallery.GetCurrentRelated(relatedObject);

Parameters

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

Returns

Boolean

GetDateTime

Velocity

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

JavaScript

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

JavaScript

var stringResponse = mediaGallery.GetExtendedAttribute(name);

Parameters

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

Returns

String

GetInt

Velocity

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

JavaScript

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

JavaScript

var stringResponse = mediaGallery.GetSerializedXml(asNameValueAttributes);

Parameters

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

Returns

String

GetSerializerData

Velocity

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

JavaScript

var serializerDataResponse = mediaGallery.GetSerializerData();

Returns

SerializerData

GetString

Velocity

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

JavaScript

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

Parameters

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

Returns

String

IsFilenameValid

Velocity

#set($booleanResponse = $mediaGallery.IsFilenameValid($fileName))

JavaScript

var booleanResponse = mediaGallery.IsFilenameValid(fileName);

Parameters

Name	Type	Description	Required	Default	Options
fileName	`String`	File Name	Required

Returns

Boolean

IsFileValid

Velocity

#set($booleanResponse = $mediaGallery.IsFileValid($filename, $isRemote, $contentLength, $user, $message))

JavaScript

var booleanResponse = mediaGallery.IsFileValid(filename, isRemote, contentLength, user, message);

Parameters

Name	Type	Description	Required
filename	`String`	Filename	Required
isRemote	`Boolean`	Is Remote	Required
contentLength	`Int64`	Content Length	Required
user	`User`	User	Required
message	`String&`	Message	Required

Returns

Boolean

IsOwner

IsOwner Overload 1

Velocity

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

JavaScript

var booleanResponse = mediaGallery.IsOwner(userid);

Parameters

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

IsOwner Overload 2

Velocity

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

JavaScript

var booleanResponse = mediaGallery.IsOwner(user);

Parameters

Name	Type	Description	Required	Default	Options
user	`User`	User	Required

IsOwner Overload 3

Velocity

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

JavaScript

var booleanResponse = mediaGallery.IsOwner(userName);

Parameters

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

Returns

Boolean

SetExtendedAttribute

Velocity

$mediaGallery.SetExtendedAttribute($name, $value)

JavaScript

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

$mediaGallery.SetOwners($users)

JavaScript

mediaGallery.SetOwners(users);

Parameters

Name	Type	Description	Required	Default	Options
users	`Array of User`	Users	Required

SetOwners Overload 2

Velocity

$mediaGallery.SetOwners($users)

JavaScript

mediaGallery.SetOwners(users);

Parameters

Name	Type	Description	Required	Default	Options
users	`IEnumerable of User`	Users	Required

Returns

Nothing

SetSerializedXml

Velocity

$mediaGallery.SetSerializedXml($xml)

JavaScript

mediaGallery.SetSerializedXml(xml);

Parameters

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

Returns

Nothing

SetSerializerData

Velocity

$mediaGallery.SetSerializerData($data)

JavaScript

mediaGallery.SetSerializerData(data);

Parameters

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

Returns

Nothing

Recommended