Fired when a profile receives a vote on their post or comment. Raised by CommentService.vote() alongside VotedEvent, for trigger and automation listeners and funnel steps keyed on the voteReceived event id or on the receiving profile. Trigger item 1 is the id of the website the voted-on post belongs to. Trigger item 2 is the vote's signed count. Trigger item 3 is the post or comment's running vote total. Trigger item 4 is the type of content voted on: C for a comment, FP for a forum post, FR for a forum reply. Trigger item 5 is unused. Event ID: voteReceived
Group: Journeys
Implements: TriggerEvent, FunnelEvent
Properties
| Property | Returns | Description |
|---|---|---|
| attributes | Map<String,Object> | Mutable attribute map used to pass extra key-value data to trigger and template rendering. Empty by default for this event. |
| eventId | String | Id used to match this event against trigger definitions: voteReceived. |
| leadProfile | Profile | Profile used for funnel matching, the poster of the post or comment that received the vote. |
| relatedLead | Lead | Lead this event relates to for funnel processing. Always null; this event is not associated with a Lead entity. |
| sourceProfile | Profile | Profile that received the vote - the poster of the post or comment being voted on. |
| triggerItem1 | String | First trigger item: the id of the website the voted-on post belongs to, as a string. |
| triggerItem2 | String | Second trigger item: the signed vote count that was cast (usually +1 or -1). |
| triggerItem3 | String | Third trigger item: the post or comment's running total vote count after this vote was applied. |
| triggerItem4 | String | Fourth trigger item: the type of content voted on - C for a comment, FP for a forum post, or FR for a forum reply. |
| triggerItem5 | String | Fifth trigger item. Always null for this event. |
| website | Website | Website the voted-on post or comment belongs to. |
Inherited from TriggerEvent
Properties
| Property | Returns | Description |
|---|---|---|
| serialisable | boolean | Whether this event's attributes were built to survive being persisted, ie every value is a plain serialisable value rather than a persistent entity or some other object that only makes sense inside the firing transaction. Only the firing app can know this, so it declares it - see EventBuilder. An agent that subscribes to an event does not run when it fires. The event is written to storage as JSON, buffered with others, and read back minutes later in a different session, so a value that cannot be written and read back is not merely awkward, it breaks the whole delivery. The agent framework therefore ignores any event which does not say yes here. |
Methods
isSerialisable()
Returns: boolean
Whether this event's attributes were built to survive being persisted, ie every value is a plain serialisable value rather than a persistent entity or some other object that only makes sense inside the firing transaction. Only the firing app can know this, so it declares it - see EventBuilder. An agent that subscribes to an event does not run when it fires. The event is written to storage as JSON, buffered with others, and read back minutes later in a different session, so a value that cannot be written and read back is not merely awkward, it breaks the whole delivery. The agent framework therefore ignores any event which does not say yes here.
Methods
getSourceProfile() · getEventId() · getWebsite() · getTriggerItem1() · getTriggerItem2() · getTriggerItem3() · getTriggerItem4() · getTriggerItem5() · getAttributes() · getLeadProfile() · getRelatedLead()
getSourceProfile()
Returns: Profile
Profile that received the vote - the poster of the post or comment being voted on.
getEventId()
Returns: String
Id used to match this event against trigger definitions: voteReceived.
getWebsite()
Returns: Website
Website the voted-on post or comment belongs to.
getTriggerItem1()
Returns: String
First trigger item: the id of the website the voted-on post belongs to, as a string.
getTriggerItem2()
Returns: String
Second trigger item: the signed vote count that was cast (usually +1 or -1).
getTriggerItem3()
Returns: String
Third trigger item: the post or comment's running total vote count after this vote was applied.
getTriggerItem4()
Returns: String
Fourth trigger item: the type of content voted on - C for a comment, FP for a forum post, or FR for a forum reply.
getTriggerItem5()
Returns: String
Fifth trigger item. Always null for this event.
getAttributes()
Returns: Map<String,Object>
Mutable attribute map used to pass extra key-value data to trigger and template rendering. Empty by default for this event.
getLeadProfile()
Returns: Profile
Profile used for funnel matching, the poster of the post or comment that received the vote.
getRelatedLead()
Returns: Lead
Lead this event relates to for funnel processing. Always null; this event is not associated with a Lead entity.