core_v2_configuration Script API

Verint | Telligent Community — Wed, 14 May 2025 17:07:40 GMT

Current Revision posted to API Documentation by Verint | Telligent Community on 05/14/2025 17:07:40

Enables scripted content fragments to read site configuration properties.

Properties

Name	Access	Type	Description
AccountActivation	Read	`[[String Script API Type\|String]]`	Configured account activation method ('Automatic', 'Email', 'AdminApproval', 'InvitationOnly')
ActivityMessageReplyMaxLength	Read	`[[Number Script API Type\|Number]]`	The maximum activity message reply length
AllowNewUserRegistration	Read	`[[Boolean Script API Type\|Boolean]]`	The maximum allowed password length
AreStatusMessagesEnabled	Read	`[[Boolean Script API Type\|Boolean]]`	Whether status messages are enabled. Now that Activity Stories have superseded activity messages, use ActivityStorySitePreferences to get more accurate information.
AuthenticationType	Read	`[[String Script API Type\|String]]`	Configured authentication type ('windows','forms','cookie')
DefaultFriendshipRequestMessage	Read	`[[String Script API Type\|String]]`	Default friendship request message
DefaultThemeContextId	Read	`[[Guid Script API Type\|Guid]]`	Default theme context identifier
Editors	Read	`[[List Script API Type\|List]] of [[SelectableEditor Script API Type\|SelectableEditor]]`	Obsolete. Obsolete in 12 Obsolete in 12. Obsolete in 12
EmailRegex	Read	`[[String Script API Type\|String]]`	Email Regular Expression Pattern
EnableActivityLogging	Read	`[[Boolean Script API Type\|Boolean]]`	Obsolete in 14.
EnableConversations	Read	`[[Boolean Script API Type\|Boolean]]`	Whether conversations are enabled
EnabledActivityMessageTypes	Read	`[[List Script API Type\|List]] of [[String Script API Type\|String]]`	Obsolete. Obsolete in 10: Use activity story types APIs instead. Obsolete in 10: Use activity story types APIs instead. Enabled Activity Message Types
EnableDisplayNames	Read	`[[Boolean Script API Type\|Boolean]]`	Whether display names are enabled
EnableEmail	Read	`[[Boolean Script API Type\|Boolean]]`	Whether email is enabled
EnableEmailDigest	Read	`[[Boolean Script API Type\|Boolean]]`	Whether email digests are enabled
EnableEmoticons	Read	`[[Boolean Script API Type\|Boolean]]`	Obsolete. Obsolete in 14. Obsolete in 14. Obsolete in 14.
EnableMailGateway	Read	`[[Boolean Script API Type\|Boolean]]`	Whether the Mail Gateway is enabled
EnableRssSearch	Read	`[[Boolean Script API Type\|Boolean]]`	Whether rss searching is enabled
EnableSignatures	Read	`[[Boolean Script API Type\|Boolean]]`	Whether signatures are enabled
EnableUserFileStorage	Read	`[[Boolean Script API Type\|Boolean]]`	Whether user file storage is enabled
EnableUserPresenceTrackingToggle	Read	`[[Boolean Script API Type\|Boolean]]`	Enable User Presence Tracking Toggle
Languages	Read	`[[List Script API Type\|List]] of [[SelectableLanguage Script API Type\|SelectableLanguage]]`	Available languages
MailGatewayEmailDomain	Read	`[[String Script API Type\|String]]`	Mail Gateway Email Domain
PasswordMinLength	Read	`[[Number Script API Type\|Number]]`	The minimum allowed password length
PasswordRecoveryMethod	Read	`[[String Script API Type\|String]]`	Configured password recovery method ('SecureLink', 'Reset', 'QuestionAndAnswer')
SectionRatingType	Read	`[[String Script API Type\|String]]`	Obsolete. Obsolete in 14. Obsolete in 14. Obsolete in 14.
ShowContactCheckboxes	Read	`[[Boolean Script API Type\|Boolean]]`	Whether contact checkboxes should be shown during joining
SignatureMaxLength	Read	`[[Number Script API Type\|Number]]`	Maximum length of signatures
SiteLogoUrl	Read	`[[String Script API Type\|String]]`	Url of the site logo
SiteName	Read	`[[String Script API Type\|String]]`	Name of the site
SiteThemeContextId	Read	`[[Guid Script API Type\|Guid]]`	Site theme context identifier
SiteThemeId	Read	`[[Guid Script API Type\|Guid]]`	Site theme identifier
SiteThemeTypeId	Read	`[[Guid Script API Type\|Guid]]`	Site theme type identifier
TimeFormat	Read	`[[String Script API Type\|String]]`	Configured time format
TimeZones	Read	`[[List Script API Type\|List]] of [[SelectableTimeZone Script API Type\|SelectableTimeZone]]`	Available time zones
UsernameMaxLength	Read	`[[Number Script API Type\|Number]]`	The maximum allowed user name length
UsernameMinLength	Read	`[[Number Script API Type\|Number]]`	The minimum allowed user name length

Methods

GetDateFormats

Available date formats

Velocity

#set($listResponse = $core_v2_configuration.GetDateFormats())

JavaScript

var listResponse = core_v2_configuration.GetDateFormats();

Returns

[[List Script API Type|List]] of [[SelectableDateFormat Script API Type|SelectableDateFormat]]

GetTimeZone

Gets a specific timezone, with hour offsets identified for the specific date.

Velocity

#set($selectableTimeZoneResponse = $core_v2_configuration.GetTimeZone($timeZoneId, $forDate))

JavaScript

var selectableTimeZoneResponse = core_v2_configuration.GetTimeZone(timeZoneId, forDate);

Parameters

Name	Type	Description	Required	Default	Options
timeZoneId	`[[String Script API Type\|String]]`	Time Zone Id	Required
forDate	`[[DateTime Script API Type\|DateTime]]`	For Date	Required

Returns

[[SelectableTimeZone Script API Type|SelectableTimeZone]]

GetTimeZones

Available time zones, with hour offsets identified for the specified date.

Velocity

#set($listResponse = $core_v2_configuration.GetTimeZones($forDate))

JavaScript

var listResponse = core_v2_configuration.GetTimeZones(forDate);

Parameters

Name	Type	Description	Required	Default	Options
forDate	`[[DateTime Script API Type\|DateTime]]`	For Date	Required

Returns

[[List Script API Type|List]] of [[SelectableTimeZone Script API Type|SelectableTimeZone]]

ToString

Velocity

#set($stringResponse = $core_v2_configuration.ToString())

JavaScript

var stringResponse = core_v2_configuration.ToString();

Returns

[[String Script API Type|String]]

Update

Update site configuration

Velocity

#set($additionalInfoResponse = $core_v2_configuration.Update("%{ SiteDescription = $siteDescriptionArg, SiteName = $siteNameArg }"))

JavaScript

var additionalInfoResponse = core_v2_configuration.Update({ SiteDescription: siteDescriptionArg, SiteName: siteNameArg });

Parameters

Name	Type	Description	Required
configuration	Options	Set of optional parameters including:	Required
SiteDescription	`[[String Script API Type\|String]]`	Site description	Optional
SiteName	`[[String Script API Type\|String]]`	Site name	Optional

Returns

[[AdditionalInfo Script API Type|AdditionalInfo]]