Package tv.phantombot.event.social
Class SocialActivityEvent
java.lang.Object
tv.phantombot.event.Event
tv.phantombot.event.social.SocialEvent
tv.phantombot.event.social.SocialActivityEvent
New activity on a social media platform that is to be announced, such as a mention or a repost
- Author:
- mcawful
-
Constructor Summary
ConstructorsConstructorDescriptionSocialActivityEvent(String platform, String pollType, SocialItem item) Constructor -
Method Summary
Modifier and TypeMethodDescriptionReturns the display name of the authorReturns the permanent id of the account that made the itemReturns the account name of the author, such as a handlegetId()Returns the platform's id of the itemReturns the poll type that found the item; chat and Discord each choose which poll types they announcegetText()Returns the text of the item; for a repost, the text of the post that was repostedgetType()Returns the kind of activitygetUrl()Returns the web address of the item; for a repost, the post that was repostedMethods inherited from class tv.phantombot.event.social.SocialEvent
getPlatform
-
Constructor Details
-
SocialActivityEvent
Constructor- Parameters:
platform- the id of the platform, such asblueskypollType- the id of the poll type that found the item, such asmentionsitem- the activity
-
-
Method Details
-
getPollType
Returns the poll type that found the item; chat and Discord each choose which poll types they announce- Returns:
- the poll type id, such as
mentions
-
getType
Returns the kind of activity- Returns:
post,repost,mention,replyorquote
-
getId
Returns the platform's id of the item- Returns:
- the id
-
getAuthorId
Returns the permanent id of the account that made the item- Returns:
- the account id
-
getAuthorName
Returns the account name of the author, such as a handle- Returns:
- the account name
-
getAuthorDisplayName
Returns the display name of the author- Returns:
- the display name; may be empty
-
getText
Returns the text of the item; for a repost, the text of the post that was reposted- Returns:
- the text
-
getUrl
Returns the web address of the item; for a repost, the post that was reposted- Returns:
- the URL
-