Enables scripted content fragments to use Activity Stories
Properties
| Name | Access | Type | Description |
|---|---|---|---|
| Current | Read | ActivityStory | Current |
| ServiceId | Read | Guid | Service identifier for activity stories/stream. |
Methods
CanDelete
Returns whether the accessing user can delete a story
Velocity
#set($booleanResponse = $core_v2_activityStory.CanDelete($storyId))
JavaScript
var booleanResponse = core_v2_activityStory.CanDelete(storyId);
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| storyId | Guid | Story Id | Required |
Returns
BooleanDelete
Deletes an activity story
Velocity
#set($additionalInfoResponse = $core_v2_activityStory.Delete($storyId))
JavaScript
var additionalInfoResponse = core_v2_activityStory.Delete(storyId);
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| storyId | Guid | Story Id | Required |
Returns
Get
Gets an activity story
Velocity
#set($activityStoryResponse = $core_v2_activityStory.Get($storyId))
JavaScript
var activityStoryResponse = core_v2_activityStory.Get(storyId);
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| storyId | Guid | Story Id | Required |
Returns
GetActivityStoryType
Velocity
#set($activityStoryTypeInfoResponse = $core_v2_activityStory.GetActivityStoryType($activityStoryTypeId))
JavaScript
var activityStoryTypeInfoResponse = core_v2_activityStory.GetActivityStoryType(activityStoryTypeId);
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| activityStoryTypeId | Guid | Activity Story Type Id | Required |
Returns
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 considerations, the result may not always return the requested PageSize of results, but it is guaranteed to return at least 1 result if any results exist when using an open-ended date range. By default, the method will first query for the last 48 hours, then for the last 96 hours, and then for all time, returning when it finds at least 1 result that matches the other given criteria. It also will not return the TotalItems value. It is recommended to page by StartDate and/or EndDate instead of PageIndex and PageSize.
Velocity
#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 }"))JavaScript
var 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 |
|---|---|---|---|---|---|
| options | Options | Set of optional parameters including: | Required | ||
| 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 | Boolean | Filter activitys stories to include all joinless groups. Used when filtering by effective member groups only. | Optional | ||
| IncludeSubContainers | Boolean | Include sub containers | Optional | ||
| IncludeUserEffectiveMemberGroups | Boolean | Filters activity stories to only groups you are a either a direct member of or a role member of. | Optional | ||
| PageIndex | Int32 | Specify the page number of paged results to return. Zero-based index. | Optional | 0 | |
| PageSize | Int32 | 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 SortBy is set to StoryIdsOrder | Optional | ||
| TypeId | Guid | Categorization identifier | Optional | ||
| UserId | Int32 | User Id | Optional |
Returns
ListActivityStoryTypes
Velocity
#set($apiListResponse = $core_v2_activityStory.ListActivityStoryTypes())
JavaScript
var apiListResponse = core_v2_activityStory.ListActivityStoryTypes();