twitter4j.api.AccountMethods Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of twitter4j-core Show documentation
A Java library for the Twitter API
The newest version!
/*
Copyright (c) 2007-2009, Yusuke Yamamoto
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
    * Redistributions of source code must retain the above copyright
      notice, this list of conditions and the following disclaimer.
    * Redistributions in binary form must reproduce the above copyright
      notice, this list of conditions and the following disclaimer in the
      documentation and/or other materials provided with the distribution.
    * Neither the name of the Yusuke Yamamoto nor the
      names of its contributors may be used to endorse or promote products
      derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY Yusuke Yamamoto ``AS IS'' AND ANY
EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL Yusuke Yamamoto BE LIABLE FOR ANY
DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package twitter4j.api;

import twitter4j.Device;
import twitter4j.RateLimitStatus;
import twitter4j.TwitterException;
import twitter4j.User;

import java.io.File;
/**
 * @author Joern Huxhorn - jhuxhorn at googlemail.com
 */
public interface AccountMethods
{
	/**
	 * Returns an HTTP 200 OK response code and a representation of the requesting user if authentication was successful; returns a 401 status code and an error message if not.  Use this method to test if supplied user credentials are valid.
	 * 
This method calls http://api.twitter.com/1/account/verify_credentials.json
	 *
	 * @return user
	 * @since Twitter4J 2.0.0
	 * @throws twitter4j.TwitterException when Twitter service or network is unavailable, or if supplied credential is wrong (TwitterException.getStatusCode() == 401)
	 * @see Twitter API Wiki / Twitter REST API Method: account verify_credentials
     */
    User verifyCredentials() throws TwitterException;

    /**
	 * Returns the remaining number of API requests available to the requesting user before the API limit is reached for the current hour. Calls to rate_limit_status do not count against the rate limit.  If authentication credentials are provided, the rate limit status for the authenticating user is returned.  Otherwise, the rate limit status for the requester's IP address is returned.

	 * 
This method calls http://api.twitter.com/1/account/rate_limit_status.json
	 *
	 * @return the rate limit status
	 * @throws TwitterException when Twitter service or network is unavailable
	 * @since Twitter4J 1.1.4
	 * @see Twitter API Wiki / Twitter REST API Method: account rate_limit_status
	 */
	RateLimitStatus getRateLimitStatus()
			throws TwitterException;

	/**
	 * Sets which device Twitter delivers updates to for the authenticating user.  Sending none as the device parameter will disable IM or SMS updates.
	 * 
This method calls http://api.twitter.com/1/account/update_delivery_device.json
	 *
	 * @param device new Delivery device. Must be one of: IM, SMS, NONE.
	 * @return the updated user
	 * @throws TwitterException when Twitter service or network is unavailable
	 * @since Twitter4J 1.0.4
	 * @see Twitter API Wiki / Twitter REST API Method: account update_delivery_device
	 */
	User updateDeliveryDevice(Device device)
			throws TwitterException;


	/**
	 * Sets one or more hex values that control the color scheme of the authenticating user's profile page on twitter.com.  These values are also returned in the getUserDetail() method.
	 * 
This method calls http://api.twitter.com/1/account/update_profile_colors.json
	 * @param profileBackgroundColor optional, can be null
	 * @param profileTextColor optional, can be null
	 * @param profileLinkColor optional, can be null
	 * @param profileSidebarFillColor optional, can be null
	 * @param profileSidebarBorderColor optional, can be null
	 * @return the updated user
	 * @throws TwitterException when Twitter service or network is unavailable
	 * @since Twitter4J 2.0.0
	 * @see Twitter API Wiki / Twitter REST API Method: account update_profile_colors
	 */
	User updateProfileColors(String profileBackgroundColor, String profileTextColor, String profileLinkColor, String profileSidebarFillColor, String profileSidebarBorderColor)
			throws TwitterException;

	/**
	 * Updates the authenticating user's profile image.
	 * 
This method calls http://api.twitter.com/1/account/update_profile_image.json
	 * @param image Must be a valid GIF, JPG, or PNG image of less than 700 kilobytes in size.  Images with width larger than 500 pixels will be scaled down.
	 * @return the updated user
	 * @throws TwitterException when Twitter service or network is unavailable,
	 *  or when the specified file is not found (FileNotFoundException will be nested),
	 *  or when the specified file object in not representing a file (IOException will be nested)
	 * @since Twitter4J 2.1.0
	 * @see Twitter API Wiki / Twitter REST API Method: account update_profile_image
	 */
	User updateProfileImage(File image)
			throws TwitterException;

	/**
	 * Updates the authenticating user's profile background image.
	 * 
This method calls http://api.twitter.com/1/account/update_profile_background_image.json
	 * @param image Must be a valid GIF, JPG, or PNG image of less than 800 kilobytes in size.  Images with width larger than 2048 pixels will be forceably scaled down.
	 * @param tile If set to true the background image will be displayed tiled. The image will not be tiled otherwise.
	 * @return the updated user
	 * @throws TwitterException when Twitter service or network is unavailable,
	 *  or when the specified file is not found (FileNotFoundException will be nested),
	 *  or when the specified file object in not representing a file (IOException will be nested)
	 * @since Twitter4J 2.1.0
	 * @see Twitter API Wiki / Twitter REST API Method: account update_profile_background_image
	 */
	User updateProfileBackgroundImage(File image, boolean tile)
			throws TwitterException;

	/**
	 * Sets values that users are able to set under the "Account" tab of their settings page. Only the parameters specified(non-null) will be updated.
	 * 
This method calls http://api.twitter.com/1/account/update_profile.json
	 *
	 * @param name Optional. Maximum of 20 characters.
	 * @param email Optional. Maximum of 40 characters. Must be a valid email address.
	 * @param url Optional. Maximum of 100 characters. Will be prepended with "http://" if not present.
	 * @param location Optional. Maximum of 30 characters. The contents are not normalized or geocoded in any way.
	 * @param description Optional. Maximum of 160 characters.
	 * @return the updated user
	 * @throws TwitterException when Twitter service or network is unavailable
	 * @since Twitter4J 2.0.2
	 * @see Twitter REST API Documentation > Account Methods > account/update_location
	 */
	User updateProfile(String name, String email, String url, String location, String description)
			throws TwitterException;

}