Enables scripted content fragments to read site configuration properties.
Properties
Name | Type | Description | Default | Options |
---|---|---|---|---|
AccountActivation | string | Configured account activation method ('Automatic', 'Email', 'AdminApproval', 'InvitationOnly') | ||
ActivityMessageReplyMaxLength | int | The maximum activity message reply length | ||
AllowNewUserRegistration | bool | The maximum allowed password length | ||
AreStatusMessagesEnabled | bool | Whether status messages are enabled. Now that Activity Stories have superseded activity messages, use ActivityStorySitePreferences to get more accurate information. | ||
AuthenticationType | string | Configured authentication type ('windows','forms','cookie') | ||
DefaultFriendshipRequestMessage | string | Default friendship request message | ||
DefaultThemeContextId | Guid | Default theme context identifier | ||
Editors | IList<SelectableEditor> | Available editors | ||
EmailRegex | string | Email Regular Expression Pattern | ||
EnableActivityLogging | bool | Whether acvitity logging is enabled | ||
EnableConversations | bool | Whether conversations are enabled | ||
EnabledActivityMessageTypes | IList<string> | Enabled activity message types. Now that Activity Stories have superseded activity messages, use ActivityStorySitePreferences to get more accurate information. | ||
EnableDisplayNames | bool | Whether display names are enabled | ||
EnableEmail | bool | Whether email is enabled | ||
EnableEmailDigest | bool | Whether email digests are enabled | ||
EnableEmoticons | bool | Whether emoticons are enabled | ||
EnableGender | bool | Whether gender is enabled | ||
EnableLdap | bool | Whether LDAP is enabled | ||
EnableMailGateway | bool | Whether the Mail Gateway is enabled | ||
EnableRssSearch | bool | Whether rss searching is enabled | ||
EnableSignatures | bool | Whether signatures are enabled | ||
EnableUserFileStorage | bool | Whether user file storage is enabled | ||
EnableUserPresenceTrackingToggle | bool | |||
Languages | IList<SelectableLanguage> | Available languages | ||
MailGatewayEmailDomain | string | Mail Gateway Email Domain | ||
PasswordMinLength | int | The minimum allowed password length | ||
PasswordRecoveryMethod | string | Configured password recovery method ('SecureLink', 'Reset', 'QuestionAndAnswer') | ||
SectionRatingType | string | Configured Section Rating Type ('ThreadRating', 'PostRating') | ||
ShowContactCheckboxes | bool | Whether contact checkboxes should be shown during joining | ||
SignatureMaxLength | int | Maximum length of signatures | ||
SiteLogoUrl | string | Url of the site logo | ||
SiteName | string | Name of the site | ||
SiteThemeContextId | Guid | Site theme context identifier | ||
SiteThemeId | Guid | Site theme identifier | ||
SiteThemeTypeId | Guid | Site theme type identifier | ||
TimeFormat | string | Configured time format | ||
TimeZones | IList<SelectableTimeZone> | Available time zones | ||
UsernameMaxLength | int | The maximum allowed user name length | ||
UsernameMinLength | int | The minimum allowed user name length |
Methods
GetDateFormats
Available date formats
Usage
#set($iListResponse = $core_v2_configuration.GetDateFormats())
Return Type
IList<SelectableDateFormat>
GetDateFormats
Available date formats for a given language
Usage
#set($iListResponse = $core_v2_configuration.GetDateFormats($languageKey))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
languageKey | string | Language key | Required |
Return Type
IList<SelectableDateFormat>
GetTimeZone
Gets a specific timezone, with hour offsets identified for the specific date.
Usage
#set($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 |
Return Type
SelectableTimeZone
GetTimeZones
Available time zones, with hour offsets identified for the specified date.
Usage
#set($iListResponse = $core_v2_configuration.GetTimeZones($forDate))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
forDate | DateTime | For Date | Required |
Return Type
IList<SelectableTimeZone>
Update
Update site configuration
Usage
#set($additionalInfoResponse = $core_v2_configuration.Update("%{LogoData = $logoDataArg, LogoFileName = $logoFileNameArg, LogoUploadContext = $logoUploadContextArg, SiteDescription = $siteDescriptionArg, SiteName = $siteNameArg}"))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
LogoData | 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 |