User Script API Type

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

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

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

Properties
Bio
HasErrors
HasWarnings
HasWarningsOrErrors
ThrowErrors

Properties

Name	Access	Type	Description
AccountStatus	Read, Write	`String`	Account Status
AllowSitePartnersToContact	Read, Write	`Nullable of Boolean`	Allow Site Partners To Contact
AllowSiteToContact	Read, Write	`Nullable of Boolean`	Allow Site To Contact
AuthenticatedSessionState	Read	`String`	Authenticated Session State
AvatarUrl	Read	`String`	Url to an image particular to the content or content type. If none, return null.
BannedUntil	Read, Write	`Nullable of DateTime`	Banned Until
BanReason	Read, Write	`String`	Ban Reason
Birthday	Read, Write	`Nullable of DateTime`	Birthday
ContentId	Read, Write	`Guid`	A Guid uniquely identifying the content.
ConversationContactType	Read, Write	`String`	Conversation Contact Type
CoverPhotoUrl	Read	`String`	Cover Photo Url
DateFormat	Read, Write	`String`	Date Format
DisplayName	Read, Write	`String`	Display Name
EditorType	Read, Write	`String`	Obsolete. This property is no longer used and will always return an empty string. Editor Type
EnableCollapsingPanels	Read, Write	`Nullable of Boolean`	Enable Collapsing Panels
EnableCommentNotifications	Read, Write	`Nullable of Boolean`	Enable Comment Notifications
EnableConversationNotifications	Read, Write	`Nullable of Boolean`	Enable Conversation Notifications
EnabledActivityMessageTypes	Read	`IList of String`	Enabled Activity Message Types
EnableDisplayInMemberList	Read, Write	`Nullable of Boolean`	Enable Display In Member List
EnableDisplayName	Read, Write	`Nullable of Boolean`	Enable Display Name
EnableEmail	Read, Write	`Nullable of Boolean`	Enable Email
EnableEmoticons	Read, Write	`Nullable of Boolean`	Obsolete. This property is obsolete Enable Emoticons
EnableFavoriteSharing	Read, Write	`Nullable of Boolean`	Enable Favorite Sharing
EnableHtmlEmail	Read, Write	`Nullable of Boolean`	Enable Html Email
EnablePostPreviewPopup	Read, Write	`Nullable of Boolean`	Enable Post Preview Popup
EnablePresenceTracking	Read, Write	`Boolean`	Enable Presence Tracking
EnableTracking	Read, Write	`Nullable of Boolean`	Obsolete. This value is no longer used. Enable Tracking
EnableUserSignatures	Read, Write	`Nullable of Boolean`	Enable User Signatures
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
ForceLogin	Read, Write	`Nullable of Boolean`	Obsolete. Obsolete in 12.1. This option is no longer used. This has been obsoleted in 12.1 and will alsways return false.
Gender	Read, Write	`String`	Gender
HasPassword	Read, Write	`Nullable of Boolean`	Has Password
Id	Read, Write	`Nullable of Int32`	Id
IsEmailVerified	Read, Write	`Nullable of Boolean`	Is Email Verified
IsIgnored	Read, Write	`Nullable of Boolean`	Is Ignored
IsSystemAccount	Read, Write	`Nullable of Boolean`	Is System Account
JoinDate	Read, Write	`Nullable of DateTime`	Join Date
Language	Read, Write	`String`	Language
LastLoginDate	Read, Write	`Nullable of DateTime`	Last Login Date
LastVisitedDate	Read, Write	`Nullable of DateTime`	Last Visited Date
Location	Read, Write	`String`	Location
ModerationLevel	Read	`String`	Moderation Level
Password	Read, Write	`String`	Password
Points	Read, Write	`Nullable of Int32`	Points
PostSortOrder	Read, Write	`String`	Post Sort Order
Presence	Read, Write	`String`	Presence
PrivateEmail	Read, Write	`String`	Private Email
ProfileFields	Read, Write	`[[ApiList Script API Type\|ApiList]] of [[ProfileField Script API Type\|ProfileField]]`	Profile Fields
ProfileUrl	Read, Write	`String`	Profile Url
PublicEmail	Read, Write	`String`	Public Email
QualityPercentile	Read, Write	`Nullable of Int32`	Quality Percentile
RawBio	Write	`String`	Raw Bio
RequiresTermsOfServiceAcceptance	Read	`Boolean`	Requires Terms Of Service Acceptance
RssFeeds	Read, Write	`IList of String`	Rss Feeds
Signature	Read, Write	`String`	Signature
SignatureFormatted	Read, Write	`String`	Signature Formatted
TermsOfServiceAcceptanceDate	Read, Write	`Nullable of DateTime`	Terms Of Service Acceptance Date
TimeZone	Read, Write	`Nullable of Double`	Time Zone
TimeZoneId	Read, Write	`String`	Time Zone Id
TimeZoneInfo	Read	`TimeZoneInfo`	Time Zone Info
TotalPosts	Read, Write	`Int32`	Total Posts
Url	Read	`String`	A Url to the content on the site.
Username	Read, Write	`String`	Username
Warnings	Read	`IList of [[Warning Script API Type\|Warning]]`	Warnings
WebUrl	Read, Write	`String`	Web Url

Methods

Bio

Bio Overload 1

Velocity

#set($stringResponse = $user.Bio())

JavaScript

var stringResponse = user.Bio();

Bio Overload 2

Velocity

#set($stringResponse = $user.Bio($postTarget))

JavaScript

var stringResponse = user.Bio(postTarget);

Parameters

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

Returns

String

HasErrors

Velocity

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

JavaScript

var booleanResponse = user.HasErrors();

Returns

Boolean

HasWarnings

Velocity

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

JavaScript

var booleanResponse = user.HasWarnings();

Returns

Boolean

HasWarningsOrErrors

Velocity

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

JavaScript

var booleanResponse = user.HasWarningsOrErrors();

Returns

Boolean

ThrowErrors

Velocity

$user.ThrowErrors()

JavaScript

user.ThrowErrors();

Returns

Nothing