This service is available via Telligent.Evolution.Extensibility.Apis.Get<Telligent.Evolution.Extensibility.Api.Version1.IActivityStories>() and is defined in Telligent.Evolution.Platform.dll
Events
Events.AfterCreate
Handler
void ActivityStoryAfterCreateEventHandler(ActivityStoryAfterCreateEventArgs e);
Events.AfterDelete
Handler
void ActivityStoryAfterDeleteEventHandler(ActivityStoryAfterDeleteEventArgs e);
Events.AfterUpdate
Handler
void ActivityStoryAfterUpdateEventHandler(ActivityStoryAfterUpdateEventArgs e);
Events.BeforeCreate
Handler
void ActivityStoryBeforeCreateEventHandler(ActivityStoryBeforeCreateEventArgs e);
Events.BeforeDelete
Handler
void ActivityStoryBeforeDeleteEventHandler(ActivityStoryBeforeDeleteEventArgs e);
Events.BeforeUpdate
Handler
void ActivityStoryBeforeUpdateEventHandler(ActivityStoryBeforeUpdateEventArgs e);
Events.Render
Handler
void ActivityStoryRenderEventHandler(ActivityStoryRenderEventArgs e);
Properties
| Name | Type | Description | Default | Options |
|---|---|---|---|---|
| DataTypeId Obsolete | Guid | Migrate usage to scripted email or scripted plugins. | ||
| ServiceId | Guid | Activity Stories service identifier |
Methods
bool CanDelete(Guid storyId);
Returns whether the accessing user can delete a story
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| storyId | Guid | Story Id | Required |
Return Type
bool
AdditionalInfo Delete(Guid storyId);
Deletes an activity story
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| storyId | Guid | Story Id | Required |
Return Type
ActivityStory Get(Guid storyId);
Gets an activity story
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| storyId | Guid | Story Id | Required |
Return Type
ActivityStoryTypeInfo GetActivityStoryType(Guid activityStoryTypeId);
Gets an activity story type by Id
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| activityStoryTypeId | Guid | Activity story type Id | Required |
Return Type
ActivityStorySitePreference GetDefaultPreference(Guid storyTypeId);
Gets a default preference
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| storyTypeId | Guid | Activity story type Id | Required |
Return Type
ApiList<ActivityStorySitePreference> GetDefaultPreferences(ActivityStorySitePreferenceListOptions options = null);
Gets a default preferences
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| options | ActivityStorySitePreferenceListOptions | Options include: Preferences | Optional |
Return Type
ApiList<ActivityStorySitePreference>
ActivityStoryUserPreference GetUserPreference(Guid storyTypeId);
Gets a user preference
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| storyTypeId | Guid | Activity story type Id | Required |
Return Type
ApiList<ActivityStoryUserPreference> GetUserPreferences();
Gets user preferences
Return Type
ApiList<ActivityStoryUserPreference>
PagedList<ActivityStory> List(ActivityStoryListOptions options = null);
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', 'following', 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.
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| options | ActivityStoryListOptions | Options include: ContentId, ContentTypeId, TypeId, ContentUrl, ContainerIds, ApplicationId, StoryIds, UserId, StartDate, EndDate, CreatedStartDate, CreatedEndDate, SortBy, SortOrder, PageSize, PageIndex, IsIndexed, Filters, IncludeUserEffectiveMemberGroups, IncludeAllJoinlessGroups | Optional |
Return Type
ApiList<ActivityStoryTypeInfo> ListActivityStoryTypes();
Lists of activity story types
Return Type
ApiList<ActivityStoryTypeInfo>
AdditionalInfo SetDefaultPreference(Guid storyTypeId, string preference);
Sets default preference
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| storyTypeId | Guid | Activity story type Id | Required | ||
| preference | string | Preference | Required |
Return Type
AdditionalInfo SetUserPreference(Guid storyTypeId, bool isLoggingEnabled);
Sets user preference
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| storyTypeId | Guid | Activity story type Id | Required | ||
| isLoggingEnabled | bool | Is logging enabled | Required |