twitter4j.api.StatusMethods 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.GeoLocation;
import twitter4j.ResponseList;
import twitter4j.Status;
import twitter4j.TwitterException;

/**
 * @author Joern Huxhorn - jhuxhorn at googlemail.com
 */
public interface StatusMethods
{
	/**
	 * Returns a single status, specified by the id parameter. The status's author will be returned inline.
	 * 
This method calls http://api.twitter.com/1/statuses/show
	 *
	 * @param id the numerical ID of the status you're trying to retrieve
	 * @return a single status
	 * @throws twitter4j.TwitterException when Twitter service or network is unavailable
	 * @since Twitter4J 2.0.1
	 * @see Twitter API Wiki / Twitter REST API Method: statuses show
	 */
	Status showStatus(long id) throws TwitterException;

	/**
	 * Updates the user's status.
	 * 
Statuses over 140 characters will be forcibly truncated.
     * 
This method calls http://api.twitter.com/1/statuses/update
	 *
	 * @param status the text of your status update
	 * @return the latest status
	 * @throws TwitterException when Twitter service or network is unavailable
	 * @since Twitter4J 2.0.1
	 * @see Twitter API Wiki / Twitter REST API Method: statuses update
	 */
	Status updateStatus(String status) throws TwitterException;

	/**
	 * Updates the user's status.
     * 
Statuses over 140 characters will be forcibly truncated.
	 * 
This method calls http://api.twitter.com/1/statuses/update
	 *
	 * @param status the text of your status update
	 * @param location The location that this tweet refers to.
	 * @return the latest status
	 * @throws TwitterException when Twitter service or network is unavailable
	 * @since Twitter4J 2.0.10
	 * @see Twitter API Wiki / Twitter REST API Method: statuses update
	 */
	Status updateStatus(String status, GeoLocation location) throws TwitterException;

	/**
	 * Updates the user's status.
     * 
Statuses over 140 characters will be forcibly truncated.
	 * 
This method calls http://api.twitter.com/1/statuses/update
	 *
	 * @param status            the text of your status update
	 * @param inReplyToStatusId The ID of an existing status that the status to be posted is in reply to.  This implicitly sets the in_reply_to_user_id attribute of the resulting status to the user ID of the message being replied to.  Invalid/missing status IDs will be ignored.
	 * @return the latest status
	 * @throws TwitterException when Twitter service or network is unavailable
	 * @since Twitter4J 2.0.1
	 * @see Twitter API Wiki / Twitter REST API Method: statuses update
	 */
	Status updateStatus(String status, long inReplyToStatusId)
			throws TwitterException;

	/**
	 * Updates the user's status.
     * 
Statuses over 140 characters will be forcibly truncated.
	 * 
This method calls http://api.twitter.com/1/statuses/update
	 *
	 * @param status            the text of your status update
	 * @param inReplyToStatusId The ID of an existing status that the status to be posted is in reply to.  This implicitly sets the in_reply_to_user_id attribute of the resulting status to the user ID of the message being replied to.  Invalid/missing status IDs will be ignored.
     * @param location The location that this tweet refers to.
	 * @return the latest status
	 * @throws TwitterException when Twitter service or network is unavailable
	 * @since Twitter4J 2.0.10
	 * @see Twitter API Wiki / Twitter REST API Method: statuses update
	 */
	Status updateStatus(String status, long inReplyToStatusId, GeoLocation location)
			throws TwitterException;

	/**
	 * Destroys the status specified by the required ID parameter.  The authenticating user must be the author of the specified status.
	 * 
This method calls http://api.twitter.com/1/statuses/destroy
	 *
	 * @param statusId The ID of the status to destroy.
	 * @return the deleted status
	 * @throws TwitterException when Twitter service or network is unavailable
	 * @since 1.0.5
	 * @see Twitter API Wiki / Twitter REST API Method: statuses destroy
	 */
	Status destroyStatus(long statusId)
			throws TwitterException;

	/**
	 * Retweets a tweet. Requires the id parameter of the tweet you are retweeting. Returns the original tweet with retweet details embedded.
	 * 
This method calls http://api.twitter.com/1/statuses/retweet
	 *
	 * @param statusId The ID of the status to retweet.
	 * @return the retweeted status
	 * @throws TwitterException when Twitter service or network is unavailable
	 * @since Twitter4J 2.0.10
	 * @see Twitter API Wiki / Twitter REST API Method: statuses retweet
	 */
	Status retweetStatus(long statusId)
			throws TwitterException;

	/**
	 * Returns up to 100 of the first retweets of a given tweet.
	 * 
This method calls http://api.twitter.com/1/statuses/retweets
	 *
	 * @param statusId The numerical ID of the tweet you want the retweets of.
	 * @return the retweets of a given tweet
	 * @throws TwitterException when Twitter service or network is unavailable
	 * @since Twitter4J 2.0.10
	 * @see Twitter API Wiki / Twitter REST API Method: statuses retweets
	 */
	ResponseList getRetweets(long statusId)
			throws TwitterException;
}