$profile_url: link to the profile of the user that tweeted this status

$retweet: expands to the result of the reteweet_format

$media: expands to the result of the photo_format string

$profile_image_url: link to the user's avatar image

$text: text of this tweet

$created_at date when this tweet was created

$relative_created_at

$screen_name: user's screen name

$name: user's name

$orig_screen_name: screen name of the user that created the original tweet

=$orig_name: name of the user that created the original tweet

$id: id of this tweet

Methods

TODO: this list is not complete yet. See additional methods at Net::Twitter.

favorites

Returns the 20 most recent favorite statuses for the authenticating user or user specified by the ID parameter.

Parameters:

user_id

screen_name

count

since_id

max_id

include_entities

Example:

%TWITTER{"favorites"}%

folowers

Returns a list of users following the specified user.

Parameters:

user_id

screen_name

Additional identifiers available when formatting results:

$created_at

$description

$favorites_count

$followers_count

$friends_count

$id

$lang

$listed_count

$location

$name

$profile_background_color

$profile_background_image_url

$profile_background_image_url_https

$profile_background_tile

$profile_image_url

$profile_image_url_https

$profile_link_color

$profile_location

$profile_sidebar_border_color

$profile_sidebar_fill_color

$profile_text_color

$profile_use_background_image

$protected

$screen_name

$status

$statuses_count

$time_zone

$url

$utc_offset

$verified

get_lists

Returns all lists the authenticating or specified user subscribes to, including their own. The user is specified using the user_id or screen_name parameters. If no user is given, the authenticating user is used.

home_timeline

Returns the 20 most recent statuses, including retweets, posted by the authenticating user and that user's friends.

Parameters:

since_id

max_id

count

exclude_replies

contributor_details

include_entities

trim_user

Example:

%TWITTER{
"home_timeline"
count="5"
}%

list_statuses

Returns tweet timeline for members of the specified list. Historically, retweets were not available in list timeline responses but you can now use the include_rts=true parameter to additionally receive retweet objects.

user_timeline

Returns the 20 most recent statuses posted by the authenticating user, or the user specified by screen_name or user_id.

Parameters:

user_id

screen_name

since_id

max_id

count

trim_user

exclude_replies

include_rts

contributor_details

Example:

%TWITTER{
"user_timeline"
id="<name>"
}%

Installation Instructions

First, you need to create a twitter app. Log in to your Twitter account and go to https://apps.twitter.com/.
Click on "Create New App" and fill out the details, i.e. insert the URL of the new Foswiki website that you've
installed this plugin on. After clicking on "Create your Twitter application" you will get to a screen allowing
you to manage and configure details as required. Click on the "Keys and Access Tokens" tab
and collect the information needed to configure TwitterPlugin using configure correctly

$Foswiki::cfg{TwitterPlugin}{APIKey}

$Foswiki::cfg{TwitterPlugin}{APISecret}

Next click on "Create my access token" and record these keys in:

$Foswiki::cfg{TwitterPlugin}{AccessToken}

$Foswiki::cfg{TwitterPlugin}{AccessSecret}

Make sure that you do NOT share this information with anybody else and that these keys are not readable
by unauthorized people inspecting the LocalSite.cfg file on your Foswiki server.