org.torproject.metricsbot.microblog

Interface MicroblogAccount

All Known Implementing Classes:

IrcChannel, MastodonAccount, TwitterAccount

public interface MicroblogAccount

Method Summary

Modifier and Type	Method and Description
java.lang.String	getFriendlyName()
java.util.List<StatusType>	getStatusTypes() Gets the list of desirable status update types for this account.
void	updateStatus(MicroblogStatus status) Conditionally updates the status for the microblogging account.
void	updateStatus(java.lang.String text, java.awt.image.RenderedImage image) Updates the status for the microblogging account.

Method Detail

updateStatus

void updateStatus(java.lang.String text,
                  java.awt.image.RenderedImage image)
           throws MicroblogUpdateFailedException

Updates the status for the microblogging account. This method should be implemented for each component. Implementations should attempt to recover from temporary errors, such as timeouts on HTTP connections.

Parameters:

text - The text of a status update

image - An image to be included in the status update, or null if no image is included

Throws:

MicroblogUpdateFailedException - Thrown if a status update fails for a microblog.

updateStatus

void updateStatus(MicroblogStatus status)
           throws MicroblogUpdateFailedException

Conditionally updates the status for the microblogging account. This method is implemented by BaseMicroblogAccountImpl so classes extending that class would only need to implement updateStatus(String, RenderedImage). This method should check to see that the status update has a type that is desired by the particular microblogging account before updating the status.

Parameters:

status - The generated status update

Throws:

MicroblogUpdateFailedException - Thrown if a status update fails for a microblog.

getStatusTypes

java.util.List<StatusType> getStatusTypes()

Gets the list of desirable status update types for this account.

Returns:

The list of desirable status update types.

See Also:

StatusType

getFriendlyName

java.lang.String getFriendlyName()