Enables scripted content fragments to use Activity Story Site Preferences
Methods
Get
Gets a specified activity story site preference
Usage
#set($activityStorySitePreferenceResponse = $core_v2_activityStorySitePreference.Get($storyTypeId))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
storyTypeId | Guid | Type of activity story | Required |
Return Type
List
Lists activity story site preferences
Usage
#set($apiListResponse = $core_v2_activityStorySitePreference.List())
Return Type
ApiList<ActivityStorySitePreference>
List
Lists activity story site preferences filtered by setting
Usage
#set($apiListResponse = $core_v2_activityStorySitePreference.List("%{Preferences = $preferencesArg}"))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
Preferences | string | Comma-separated list of Preferences to filter by | Optional | AlwaysOff, AlwaysOnHidden, AlwaysOnVisible, ControlledOptIn, ControlledOptOut |
Return Type
ApiList<ActivityStorySitePreference>
Update
Updates an activity story site preference. AlwaysOff = The activity is never logged and the user cannot see or change the setting. AlwaysOnHidden = The activity is always logged and the user cannot see or change the setting. AlwaysOnVisible = The activity is always logged and the user cannot change the setting, but the setting is visible to the user. ControlledOptIn = The activity is not logged by default, but the user can see and change the setting. ControlledOptOut = The activity is logged by default, but the user can see and change the setting.
Usage
#set($additionalInfoResponse = $core_v2_activityStorySitePreference.Update($storyTypeId, $preference))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
storyTypeId | Guid | Type of activity story | Required | ||
preference | string | New preference | Required | AlwaysOff, AlwaysOnHidden, AlwaysOnVisible, ControlledOptIn, ControlledOptOut |