C# Class Rock.Follow.EventComponent

Base class for following provider components
Inheritance: Rock.Extension.Component
Exibir arquivo Open project: NewSpring/Rock

Public Methods

Method Description
EventComponent ( ) : System

Initializes a new instance of the EventComponent class.
FormatEntityNotification ( FollowingEventType followingEvent, IEntity entity ) : string

Formats the entity notification.
GetAttributeValue ( string key ) : string

Use GetAttributeValue( FollowingEvent followingEvent, string key) instead. event component attribute values are specific to the following event instance (rather than global). This method will throw an exception
HasEventHappened ( FollowingEventType followingEvent, IEntity entity, System.DateTime lastNotified ) : bool

Determines whether [has event happened] [the specified entity].
LoadAttributes ( FollowingEventType followingEvent ) : void

Loads the attributes for the following event.

Protected Methods

Method Description
GetAttributeValue ( FollowingEventType followingEvent, string key ) : string

Gets the attribute value for the event

Method Details

EventComponent() public method

Initializes a new instance of the EventComponent class.
public EventComponent ( ) : System
return System

FormatEntityNotification() public method

Formats the entity notification.
public FormatEntityNotification ( FollowingEventType followingEvent, IEntity entity ) : string
followingEvent FollowingEventType The following event.
entity IEntity The entity.
return string

GetAttributeValue() protected method

Gets the attribute value for the event
protected GetAttributeValue ( FollowingEventType followingEvent, string key ) : string
followingEvent FollowingEventType The following event.
key string The key.
return string

GetAttributeValue() public method

Use GetAttributeValue( FollowingEvent followingEvent, string key) instead. event component attribute values are specific to the following event instance (rather than global). This method will throw an exception
Event Component attributes are saved specific to the following event, which requires that the current following event is included in order to load or retrieve values. Use the GetAttributeValue( FollowingEvent followingEvent, string key ) method instead.
public GetAttributeValue ( string key ) : string
key string The key.
return string

HasEventHappened() public abstract method

Determines whether [has event happened] [the specified entity].
public abstract HasEventHappened ( FollowingEventType followingEvent, IEntity entity, System.DateTime lastNotified ) : bool
followingEvent FollowingEventType The following event.
entity IEntity The entity.
lastNotified System.DateTime The last notified.
return bool

LoadAttributes() public method

Loads the attributes for the following event.
public LoadAttributes ( FollowingEventType followingEvent ) : void
followingEvent FollowingEventType The following event.
return void