core_v2_configuration Script API

Ben Tiedt — Wed, 20 Nov 2019 14:53:22 GMT

Current Revision posted to API Documentation by Ben Tiedt on 11/20/2019 14:53:22

Enables scripted content fragments to read site configuration properties.

Properties
GetDateFormats
GetTimeZone
GetTimeZones
Update

Properties

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

Methods

GetDateFormats

GetDateFormats Overload 1

Available date formats

Velocity

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

JavaScript

var iListResponse = core_v2_configuration.GetDateFormats();

GetDateFormats Overload 2

Available date formats for a given language

Velocity

#set($iListResponse = $core_v2_configuration.GetDateFormats($languageKey))

JavaScript

var iListResponse = core_v2_configuration.GetDateFormats(languageKey);

Parameters

Name	Type	Description	Required	Default	Options
languageKey	`String`	Language key	Required

Returns

IList 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`	Time Zone Id	Required
forDate	`DateTime`	For Date	Required

Returns

[[SelectableTimeZone Script API Type|SelectableTimeZone]]

GetTimeZones

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

Velocity

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

JavaScript

var iListResponse = core_v2_configuration.GetTimeZones(forDate);

Parameters

Name	Type	Description	Required	Default	Options
forDate	`DateTime`	For Date	Required

Returns

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

Update

Update site configuration

Velocity

#set($additionalInfoResponse = $core_v2_configuration.Update("%{ LogoData = $logoDataArg, LogoFileName = $logoFileNameArg, LogoUploadContext = $logoUploadContextArg, SiteDescription = $siteDescriptionArg, SiteName = $siteNameArg }"))

JavaScript

var additionalInfoResponse = core_v2_configuration.Update({ LogoData: logoDataArg, LogoFileName: logoFileNameArg, LogoUploadContext: logoUploadContextArg, SiteDescription: siteDescriptionArg, SiteName: siteNameArg });

Parameters

Name	Type	Description	Required
LogoData	`Array of Byte`	File's byte array	Optional
LogoFileName	`String`	Name of file being uploaded	Optional
LogoUploadContext	`String`	Upload context information	Optional
SiteDescription	`String`	Site description	Optional
SiteName	`String`	Site name	Optional

Returns

[[AdditionalInfo Script API Type|AdditionalInfo]]