UserBeforeUpdateEventArgs Script API Type

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

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

Properties
GetExtendedAttributeBool
GetExtendedAttributeDateTime
GetExtendedAttributeGuid
GetExtendedAttributeInt
GetExtendedAttributeString
SetExtendedAttributeDateTime
SetExtendedAttributeGuid
SetExtendedAttributeInt
SetExtendedAttributeString

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
AvatarUrl	Read	`String`	Avatar Url
BannedUntil	Read, Write	`Nullable of DateTime`	Banned Until
BanReason	Read, Write	`String`	Ban Reason
Bio	Read, Write	`String`	Bio
Birthday	Read, Write	`Nullable of DateTime`	Birthday
ContentId	Read	`Guid`	Content Id
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
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`	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	`Nullable of Boolean`	Enable Presence Tracking
EnableTracking	Read, Write	`Nullable of Boolean`	Obsolete. This value is no longer used, and will always return true Enable Tracking
EnableUserSignatures	Read, Write	`Nullable of Boolean`	Enable User Signatures
ExtendedAttributes	Read	`[[ApiList Script API Type\|ApiList]] of [[ExtendedAttribute Script API Type\|ExtendedAttribute]]`	Extended Attributes
Gender	Read, Write	`String`	Gender
HasPassword	Read	`Nullable of Boolean`	Has Password
Id	Read	`Nullable of Int32`	Id
InternalEntity	Read	`[[User Script API Type\|User]]`	Internal Entity
IsRenamed	Read	`Boolean`	Is Renamed
IsSystemAccount	Read	`Nullable of Boolean`	Is System Account
JoinDate	Read	`Nullable of DateTime`	Join Date
Language	Read, Write	`String`	Language
LastLoginDate	Read	`Nullable of DateTime`	Last Login Date
Location	Read, Write	`String`	Location
ModerationLevel	Read	`String`	Moderation Level
Points	Read	`Nullable of Int32`	Points
PostSortOrder	Read, Write	`String`	Post Sort Order
Presence	Read, Write	`String`	Presence
PrivateEmail	Read	`String`	Private Email
ProfileFields	Read, Write	`[[ApiList Script API Type\|ApiList]] of [[ProfileField Script API Type\|ProfileField]]`	Profile Fields
ProfileUrl	Read	`String`	Profile Url
PublicEmail	Read, Write	`String`	Public Email
QualityPercentile	Read	`Nullable of Int32`	Quality Percentile
RenamedUsername	Read	`String`	Renamed Username
RssFeeds	Read, Write	`IList of String`	Rss Feeds
Signature	Read, Write	`String`	Signature
SignatureFormatted	Read, Write	`String`	Signature Formatted
TimeZone	Read, Write	`Nullable of Double`	Time Zone
TimeZoneId	Read, Write	`String`	Time Zone Id
TimeZoneInfo	Read	`String`	Time Zone Info
Username	Read	`String`	Username
WebUrl	Read, Write	`String`	Web Url

Methods

GetExtendedAttributeBool

Velocity

#set($booleanResponse = $context_v2_automationTrigger.Arguments.GetExtendedAttributeBool($name, $defaultValue))

JavaScript

var booleanResponse = context_v2_automationTrigger.Arguments.GetExtendedAttributeBool(name, defaultValue);

Parameters

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

Returns

Boolean

GetExtendedAttributeDateTime

Velocity

#set($dateTimeResponse = $context_v2_automationTrigger.Arguments.GetExtendedAttributeDateTime($name, $defaultValue))

JavaScript

var dateTimeResponse = context_v2_automationTrigger.Arguments.GetExtendedAttributeDateTime(name, defaultValue);

Parameters

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

Returns

DateTime

GetExtendedAttributeGuid

Velocity

#set($guidResponse = $context_v2_automationTrigger.Arguments.GetExtendedAttributeGuid($name, $defaultValue))

JavaScript

var guidResponse = context_v2_automationTrigger.Arguments.GetExtendedAttributeGuid(name, defaultValue);

Parameters

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

Returns

Guid

GetExtendedAttributeInt

Velocity

#set($int32Response = $context_v2_automationTrigger.Arguments.GetExtendedAttributeInt($name, $defaultValue))

JavaScript

var int32Response = context_v2_automationTrigger.Arguments.GetExtendedAttributeInt(name, defaultValue);

Parameters

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

Returns

Int32

GetExtendedAttributeString

Velocity

#set($stringResponse = $context_v2_automationTrigger.Arguments.GetExtendedAttributeString($name, $defaultValue))

JavaScript

var stringResponse = context_v2_automationTrigger.Arguments.GetExtendedAttributeString(name, defaultValue);

Parameters

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

Returns

String

SetExtendedAttributeDateTime

Velocity

$context_v2_automationTrigger.Arguments.SetExtendedAttributeDateTime($name, $value)

JavaScript

context_v2_automationTrigger.Arguments.SetExtendedAttributeDateTime(name, value);

Parameters

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

Returns

Nothing

SetExtendedAttributeGuid

Velocity

$context_v2_automationTrigger.Arguments.SetExtendedAttributeGuid($name, $value)

JavaScript

context_v2_automationTrigger.Arguments.SetExtendedAttributeGuid(name, value);

Parameters

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

Returns

Nothing

SetExtendedAttributeInt

Velocity

$context_v2_automationTrigger.Arguments.SetExtendedAttributeInt($name, $value)

JavaScript

context_v2_automationTrigger.Arguments.SetExtendedAttributeInt(name, value);

Parameters

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

Returns

Nothing

SetExtendedAttributeString

Velocity

$context_v2_automationTrigger.Arguments.SetExtendedAttributeString($name, $value)

JavaScript

context_v2_automationTrigger.Arguments.SetExtendedAttributeString(name, value);

Parameters

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

Returns

Nothing