Enables scripted content fragments to use Activity Stories
Properties
Name | Type | Description | Default | Options |
---|---|---|---|---|
Current | ActivityStory | |||
ServiceId | Guid | Service identifier for activity stories/stream. |
Methods
CanDelete
Returns whether the accessing user can delete a story
Usage
#set($booleanResponse = $core_v2_activityStory.CanDelete($storyId))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
storyId | Guid | Story Id | Required |
Return Type
bool
Delete
Deletes an activity story
Usage
#set($additionalInfoResponse = $core_v2_activityStory.Delete($storyId))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
storyId | Guid | Story Id | Required |
Return Type
Get
Gets an activity story
Usage
#set($activityStoryResponse = $core_v2_activityStory.Get($storyId))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
storyId | Guid | Story Id | Required |
Return Type
GetActivityStoryType
Usage
#set($activityStoryTypeInfoResponse = $core_v2_activityStory.GetActivityStoryType($activityStoryTypeId))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
activityStoryTypeId | Guid | Activity Story Type Id | Required |
Return Type
List
Lists activity stories. Additional story filters can be passed in the format _Filter_STORYID = 'INCLUDEDUSERS' where INCLUDEDUSERS is a comma-separated list of the options 'all', 'followed', and 'user' and 'user' refers to the user specifid by UserId. Due to performance improvements in the Activity Stream feature, List() may not always return PAGESIZE results, but it is guaranteed to return at least 1 story when using the default StartDate. By default, the method will first query for the last 48 hours, then for the last 96 hours, and then for all site activity, returning when it finds at least 1 story that matches the other given criteria. It also will not return the TOTALITEMS value.
Usage
#set($pagedListResponse = $core_v2_activityStory.List("%{ApplicationId = $applicationIdArg, ContainerIds = $containerIdsArg, ContentId = $contentIdArg, ContentTypeId = $contentTypeIdArg, CreatedEndDate = $createdEndDateArg, CreatedStartDate = $createdStartDateArg, EndDate = $endDateArg, IncludeAllJoinlessGroups = $includeAllJoinlessGroupsArg, IncludeSubContainers = $includeSubContainersArg, IncludeUserEffectiveMemberGroups = $includeUserEffectiveMemberGroupsArg, PageIndex = $pageIndexArg, PageSize = $pageSizeArg, SortBy = $sortByArg, SortOrder = $sortOrderArg, StartDate = $startDateArg, StoryIds = $storyIdsArg, TypeId = $typeIdArg, UserId = $userIdArg}"))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
ApplicationId | Guid | Content application identifier | Optional | ||
ContainerIds | string | Comma-separated list of content container ids | Optional | ||
ContentId | Guid | Content identifier | Optional | ||
ContentTypeId | Guid | Content type identifier | Optional | ||
CreatedEndDate | DateTime | Created End Date | Optional | ||
CreatedStartDate | DateTime | Created Start Date | Optional | ||
EndDate | DateTime | End Date | Optional | Current time | |
IncludeAllJoinlessGroups | bool | Include joinless groups | Optional | ||
IncludeSubContainers | bool | Include sub containers | Optional | ||
IncludeUserEffectiveMemberGroups | bool | Include groups you are a member of or created content in | Optional | ||
PageIndex | int | Specify the page number of paged results to return. Zero-based index. | Optional | 0 | |
PageSize | int | Specify the number of results to return per page. | Optional | 20 | |
SortBy | string | Sort mechanism. Option 'Date' is obsolete. | Optional | LastUpdatedDate | CreatedDate, Date, LastUpdatedDate, StoryIdsOrder |
SortOrder | string | Sort order | Optional | Ascending | Ascending, Descending |
StartDate | DateTime | Start Date | Optional | 48 hours prior to EndDate | |
StoryIds | string | Comma separated list of StoryIds. Used to limit to a specific set of stories as well as sort order if SoryBy is set to StoryIdsOrder | Optional | ||
TypeId | Guid | Categorization identifier | Optional | ||
UserId | int | User Id | Optional |
Return Type
ListActivityStoryTypes
Usage
#set($apiListResponse = $core_v2_activityStory.ListActivityStoryTypes())