Media Script API Type

Ben Tiedt — Fri, 08 Mar 2024 17:27:42 GMT

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

Content created on the site must implement this interface for the social services to support it.

Properties
Body
HasErrors
HasWarnings
HasWarningsOrErrors
ThrowErrors

Properties

Name	Access	Type	Description
Application	Read	`[[Application Script API Type\|Application]]`	The application in which the IContent is located.
Author	Read, Write	`[[User Script API Type\|User]]`	Author
AvatarUrl	Read	`String`	Url to an image particular to the content or content type. If none, return null.
CommentCount	Read, Write	`Nullable of Int32`	Comment Count
ContentId	Read, Write	`Guid`	A Guid uniquely identifying the content.
Date	Read, Write	`Nullable of DateTime`	Date
Downloads	Read, Write	`Nullable of Int32`	Downloads
EmbedCode	Read, Write	`String`	Embed Code
Errors	Read	`IList of [[Error Script API Type\|Error]]`	Errors
ExtendedAttributes	Read, Write	`[[ApiList Script API Type\|ApiList]] of [[ExtendedAttribute Script API Type\|ExtendedAttribute]]`	Extended Attributes
FeaturedImage	Read, Write	`String`	Featured Image
File	Read, Write	`[[MediaFile Script API Type\|MediaFile]]`	File
GroupId	Read, Write	`Nullable of Int32`	Group Id
Id	Read, Write	`Nullable of Int32`	Id
IsApproved	Read, Write	`Nullable of Boolean`	Is Approved
IsFeatured	Read, Write	`Nullable of Boolean`	Is Featured
MediaGalleryId	Read, Write	`Nullable of Int32`	Media Gallery Id
MetaDescription	Read, Write	`String`	Meta Description
MetaKeywords	Read, Write	`String`	Meta Keywords
MetaTitle	Read, Write	`String`	Meta Title
OpenGraphDescription	Read, Write	`String`	Open Graph Description
OpenGraphImage	Read, Write	`[[MediaFile Script API Type\|MediaFile]]`	Open Graph Image
OpenGraphTitle	Read, Write	`String`	Open Graph Title
RatingCount	Read, Write	`Nullable of Int32`	Rating Count
RatingSum	Read, Write	`Nullable of Int32`	Rating Sum
SearchUniqueId	Read	`String`	Search Unique Id
Tags	Read, Write	`IList of String`	Tags
Title	Read, Write	`String`	Title
Url	Read, Write	`String`	A Url to the content on the site.
Views	Read, Write	`Nullable of Int32`	Views
Warnings	Read	`IList of [[Warning Script API Type\|Warning]]`	Warnings

Methods

Body

Body Overload 1

Velocity

#set($stringResponse = $media.Body())

JavaScript

var stringResponse = media.Body();

Body Overload 2

Velocity

#set($stringResponse = $media.Body($postTarget))

JavaScript

var stringResponse = media.Body(postTarget);

Parameters

Name	Type	Description	Required	Default	Options
postTarget	`String`	Post Target	Required

Returns

String

HasErrors

Velocity

#set($booleanResponse = $media.HasErrors())

JavaScript

var booleanResponse = media.HasErrors();

Returns

Boolean

HasWarnings

Velocity

#set($booleanResponse = $media.HasWarnings())

JavaScript

var booleanResponse = media.HasWarnings();

Returns

Boolean

HasWarningsOrErrors

Velocity

#set($booleanResponse = $media.HasWarningsOrErrors())

JavaScript

var booleanResponse = media.HasWarningsOrErrors();

Returns

Boolean

ThrowErrors

Velocity

$media.ThrowErrors()

JavaScript

media.ThrowErrors();

Returns

Nothing