winterwell.jtwitter

Class Twitter_Account

java.lang.Object

winterwell.jtwitter.Twitter_Account

public class Twitter_Account
extends java.lang.Object

Access the account methods: e.g. change your profile colours.

Note that user blocking/unblocking methods are in Twitter_Users -- see Twitter.users()

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Twitter_Account.KAccessLevel The access level is set for the application as a whole! If you want different levels, make several applications.
static class	Twitter_Account.Search

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COLOR_BG
static java.lang.String	COLOR_LINK
static java.lang.String	COLOR_SIDEBAR_BORDER
static java.lang.String	COLOR_SIDEBAR_FILL
static java.lang.String	COLOR_TEXT

Constructor Summary

Constructors

Constructor and Description
Twitter_Account(Twitter jtwit)

Method Summary

Modifier and Type	Method and Description
Twitter_Account.Search	createSavedSearch(java.lang.String query) Create a new saved search.
Twitter_Account.Search	destroySavedSearch(java.lang.Long id) Delete one of the user's saved searches!
Twitter_Account.KAccessLevel	getAccessLevel() Deprecated. It seems Twitter have stopped sending this info! Expect null from this method.
java.util.Map<java.lang.String,RateLimit>	getRateLimits() Call Twitter to fetch rate-limit info.
java.util.List<Twitter_Account.Search>	getSavedSearches()
void	removeProfileBanner() See setProfileBanner - don't expect a useful response, just "OK" or error
User	setProfile(java.lang.String name, java.lang.String url, java.lang.String location, java.lang.String description) Update profile.
void	setProfileBanner(java.io.File image) See https://dev.twitter.com/rest/reference/post/account/update_profile_banner NB: The API supports cropping, but we have not implemented this yet.
User	setProfileColors(java.util.Map<java.lang.String,java.lang.String> colorName2hexCode) Set the authenticating user's colors.
User	setProfileDescription(java.lang.String description) Convenience method for setProfile(String, String, String, String)
User	setProfileImage(java.io.File image) See https://dev.twitter.com/rest/reference/post/account/update_profile_image.
User	setProfileLink(java.lang.String url) Convenience method for setProfile(String, String, String, String)
User	setProfileLocation(java.lang.String locn) Convenience method for setProfile(String, String, String, String)
java.lang.String	toString()
User	verifyCredentials() Test the login credentials -- and get some user info (which gets cached at Twitter.getSelf()).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

COLOR_BG

public static java.lang.String COLOR_BG

COLOR_LINK

public static java.lang.String COLOR_LINK

COLOR_SIDEBAR_BORDER

public static java.lang.String COLOR_SIDEBAR_BORDER

COLOR_SIDEBAR_FILL

public static java.lang.String COLOR_SIDEBAR_FILL

COLOR_TEXT

public static java.lang.String COLOR_TEXT

Constructor Detail

Twitter_Account

public Twitter_Account(Twitter jtwit)

Method Detail

getRateLimits

public java.util.Map<java.lang.String,RateLimit> getRateLimits()

Call Twitter to fetch rate-limit info. This method is itself rate-limited!

See Also:

Twitter.IHttpClient.getRateLimits()

createSavedSearch

public Twitter_Account.Search createSavedSearch(java.lang.String query)

Create a new saved search.

Parameters:

query - The search query

Returns:

the new search

destroySavedSearch

public Twitter_Account.Search destroySavedSearch(java.lang.Long id)

Delete one of the user's saved searches!

Parameters:

id - The id for this search

Returns:

the deleted search

getAccessLevel

public Twitter_Account.KAccessLevel getAccessLevel()

Deprecated. It seems Twitter have stopped sending this info! Expect null from this method.

Returns:

What access level does this login have? If the login is bogus, this will return Twitter_Account.KAccessLevel.NONE.

getSavedSearches

public java.util.List<Twitter_Account.Search> getSavedSearches()

Returns:

The current user's saved searches on Twitter. Use Twitter.ITweet.getText() to retrieve the search query.

setProfile

public User setProfile(java.lang.String name,
                       java.lang.String url,
                       java.lang.String location,
                       java.lang.String description)

Update profile.

Parameters:

name - Can be null for no change. Full name associated with the profile. Maximum of 20 characters.

url - Can be null for no change. URL associated with the profile. Will be prepended with "http://" if not present. Maximum of 100 characters.

location - Can be null for no change. The city or country describing where the user of the account is located. The contents are not normalized or geocoded in any way. Maximum of 30 characters.

description - Can be null for no change. A description of the user. Maximum of 160 characters.

Returns:

updated User object

setProfileDescription

public User setProfileDescription(java.lang.String description)

Convenience method for setProfile(String, String, String, String)

Parameters:

description -

setProfileLink

public User setProfileLink(java.lang.String url)

Convenience method for setProfile(String, String, String, String)

Parameters:

description -

setProfileLocation

public User setProfileLocation(java.lang.String locn)

Convenience method for setProfile(String, String, String, String)

Parameters:

description -

setProfileImage

public User setProfileImage(java.io.File image)

See https://dev.twitter.com/rest/reference/post/account/update_profile_image. Note: changes may take 5 seconds to be processed.

Parameters:

image - gif, jpg, or png <700k. Larger images will be scaled by Twitter. Use a square image! Otherwise Twitter will crop it ruthlessly.

Returns:

User

setProfileBanner

public void setProfileBanner(java.io.File image)

See https://dev.twitter.com/rest/reference/post/account/update_profile_banner NB: The API supports cropping, but we have not implemented this yet.

Parameters:

image -

removeProfileBanner

public void removeProfileBanner()

See setProfileBanner - don't expect a useful response, just "OK" or error

setProfileColors

public User setProfileColors(java.util.Map<java.lang.String,java.lang.String> colorName2hexCode)

Set the authenticating user's colors.

Parameters:

colorName2hexCode - Use the COLOR_XXX constants as keys, and 3 or 6 letter hex-codes as values (e.g. 0f0 or 00ff00 both code for green). You can set as many colors as you like (but at least one).

Returns:

updated User object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

verifyCredentials

public User verifyCredentials()
                       throws TwitterException.E401

Test the login credentials -- and get some user info (which gets cached at Twitter.getSelf()).

Returns:

a representation of the requesting user if authentication was successful

Throws:

TwitterException.E401 - thrown if the authorisation credentials fail.

See Also:

Twitter.isValidLogin()