IActivityStoryUpdateIdentifier Plugin Type

Former Member — Fri, 13 May 2022 19:22:46 GMT

Current Revision posted to API Documentation by Former Member on 05/13/2022 19:22:46

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 Plugin Type|IPlugin]]
{
	bool IsCacheable { get;  }
	Guid[] StoryTypeIds { get;  }
	bool VaryCacheByUser { get;  }
	string[] Verbs { get;  }
	int? GetPrimaryUser([[IActivityStory Plugin Supplementary Type|IActivityStory]] story);
	string GetViewHtml([[IActivityStory Plugin Supplementary Type|IActivityStory]] story, [[Target Plugin Supplementary Type|Target]] target);
	void SetController([[IActivityStoryUpdateController Plugin Supplementary Type|IActivityStoryUpdateController]] controller);
}

Properties

Name	Type	Description
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 Plugin Supplementary Type\|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 Plugin Supplementary Type\|IActivityStory]]`	Story	Required
target	`[[Target Plugin Supplementary Type\|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 Plugin Supplementary Type\|IActivityStoryUpdateController]]`	Controller	Required

IActivityStoryUpdateIdentifier Plugin Type

Ben Tiedt — Fri, 15 Jan 2021 19:26:32 GMT

Revision 1 posted to API Documentation by Ben Tiedt on 01/15/2021 19:26:32

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 Plugin Type|IPlugin]]
{
	bool IsCacheable { get;  }
	Guid[] StoryTypeIds { get;  }
	bool VaryCacheByUser { get;  }
	string[] Verbs { get;  }
	int? GetPrimaryUser([[IActivityStory Plugin Supplementary Type|IActivityStory]] story);
	string GetViewHtml([[IActivityStory Plugin Supplementary Type|IActivityStory]] story, [[Target Plugin Supplementary Type|Target]] target);
	void SetController([[IActivityStoryUpdateController Plugin Supplementary Type|IActivityStoryUpdateController]] controller);
}

Properties

Name	Type	Description
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 Plugin Supplementary Type\|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 Plugin Supplementary Type\|IActivityStory]]`	Story	Required
target	`[[Target Plugin Supplementary Type\|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 Plugin Supplementary Type\|IActivityStoryUpdateController]]`	Controller	Required