C# Класс Rock.Follow.SuggestionComponent

Base class for following provider components
Наследование: Rock.Extension.Component
Показать файл Открыть проект

Открытые методы

Метод Описание
FormatEntityNotification ( FollowingSuggestionType followingSuggestionType, IEntity entity ) : string

Formats the entity notification.

GetAttributeValue ( string key ) : string

Use GetAttributeValue( FollowingSuggestion followingSuggestion, string key) instead. suggestion component attribute values are specific to the following suggestion instance (rather than global). This method will throw an exception

GetSuggestions ( FollowingSuggestionType followingSuggestionType, List FollowerPersonIds ) : List

Gets the suggestions.

LoadAttributes ( FollowingSuggestionType followingSuggestion ) : void

Loads the attributes for the following suggestion.

SortEntities ( List entities ) : List

Sorts the entities.

SuggestionComponent ( ) : System

Initializes a new instance of the SuggestionComponent class.

Защищенные методы

Метод Описание
GetAttributeValue ( FollowingSuggestionType followingSuggestion, string key ) : string

Gets the attribute value for the suggestion

Описание методов

FormatEntityNotification() публичный Метод

Formats the entity notification.
public FormatEntityNotification ( FollowingSuggestionType followingSuggestionType, IEntity entity ) : string
followingSuggestionType FollowingSuggestionType Type of the following suggestion.
entity IEntity The entity.
Результат string

GetAttributeValue() защищенный Метод

Gets the attribute value for the suggestion
protected GetAttributeValue ( FollowingSuggestionType followingSuggestion, string key ) : string
followingSuggestion FollowingSuggestionType The following suggestion.
key string The key.
Результат string

GetAttributeValue() публичный Метод

Use GetAttributeValue( FollowingSuggestion followingSuggestion, string key) instead. suggestion component attribute values are specific to the following suggestion instance (rather than global). This method will throw an exception
Suggestion Component attributes are saved specific to the following suggestion, which requires that the current following suggestion is included in order to load or retrieve values. Use the GetAttributeValue( FollowingSuggestion followingSuggestion, string key ) method instead.
public GetAttributeValue ( string key ) : string
key string The key.
Результат string

GetSuggestions() публичный абстрактный Метод

Gets the suggestions.
public abstract GetSuggestions ( FollowingSuggestionType followingSuggestionType, List FollowerPersonIds ) : List
followingSuggestionType FollowingSuggestionType Type of the following suggestion.
FollowerPersonIds List The follower person ids.
Результат List

LoadAttributes() публичный Метод

Loads the attributes for the following suggestion.
public LoadAttributes ( FollowingSuggestionType followingSuggestion ) : void
followingSuggestion FollowingSuggestionType The following suggestion.
Результат void

SortEntities() публичный Метод

Sorts the entities.
public SortEntities ( List entities ) : List
entities List The entities.
Результат List

SuggestionComponent() публичный Метод

Initializes a new instance of the SuggestionComponent class.
public SuggestionComponent ( ) : System
Результат System