Update identifiers are used to provide explanation regarding updated or 'bumped' activity stories.
IActivityStoryUpdateIdentifier
is defined in the Telligent.Evolution.Extensibility.Content.Version1
namespace of Telligent.Evolution.Platform.dll
Definition
interface IActivityStoryUpdateIdentifier : IPlugin { bool IsCacheable { get; } Guid[] StoryTypeIds { get; } bool VaryCacheByUser { get; } string[] Verbs { get; } int? GetPrimaryUser(IActivityStory story); string GetViewHtml(IActivityStory story, Target target); void SetController(IActivityStoryUpdateController controller); }
Properties
Name | Type | Description | Default | Options |
---|---|---|---|---|
IsCacheable | bool | A flag to allow caching of the output of GetViewHtml(). | ||
StoryTypeIds | Guid[] | Optional list of stories supported by this update identifier. | ||
VaryCacheByUser | bool | A flag to cache on a per user basis, particularly useful for security reasons. | ||
Verbs | string[] | List of actor verbs applicable to this update identifier. |
Methods
int? GetPrimaryUser(IActivityStory story);
Returns the primary actor’s UserId related to the update for the given activity story. This is usually the user who updated the content associated to the story.
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
story | IActivityStory | Story | Required |
Return Type
int?
string GetViewHtml(IActivityStory story, Target target);
This returns the rendered description for the update to the activity story.
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
story | IActivityStory | Story | Required | ||
target | Target | Target | Required |
Return Type
string
void SetController(IActivityStoryUpdateController controller);
This method is called each time the plugin is loaded. The controller gives privileged access to the plugin not available via the API.
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
controller | IActivityStoryUpdateController | Controller | Required |