twitter4j.api.TweetsResourcesAsync Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of twitter4j-async Show documentation
A Java library for the Twitter API
There is a newer version: 4.0.7
/*
 * Copyright 2007 Yusuke Yamamoto
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package twitter4j.api;


import twitter4j.OEmbedRequest;
import twitter4j.StatusUpdate;

/**
 * @author Joern Huxhorn - jhuxhorn at googlemail.com
 */
public interface TweetsResourcesAsync {
    /**
     * Returns up to 100 of the first retweets of a given tweet.
     * 
This method calls https://api.twitter.com/1.1/statuses/retweets
     *
     * @param statusId The numerical ID of the tweet you want the retweets of.
     * @see Tweets Resources › statuses/retweets/:id
     * @since Twitter4J 2.1.0
     */
    void getRetweets(long statusId);

    /**
     * Returns a single status, specified by the id parameter below. The status's author will be returned inline.
     * 
This method calls https://api.twitter.com/1.1/statuses/show
     *
     * @param id int
     * @see GET statuses/show/:id | Twitter Developers
     * @since Twitter4J 2.0.1
     */
    void showStatus(long id);

    /**
     * Destroys the status specified by the required ID parameter.

     * Usage note: The authenticating user must be the author of the specified status.
     * 
This method calls https://api.twitter.com/1.1/statuses/destroy
     *
     * @param statusId String
     * @see POST statuses/destroy/:id | Twitter Developers
     * @since 1.1.2
     */
    void destroyStatus(long statusId);

    /**
     * Updates the authenticating user's status. A status update with text identical to the authenticating user's text identical to the authenticating user's current status will be ignored to prevent duplicates.
     * 
This method calls https://api.twitter.com/1.1/statuses/update
     *
     * @param status String
     * @see POST statuses/update | Twitter Developers
     * @since Twitter4J 2.0.1
     */
    void updateStatus(String status);

    /**
     * Updates the authenticating user's status. A status update with text identical to the authenticating user's text identical to the authenticating user's current status will be ignored to prevent duplicates.
     * 
Statuses over 140 characters will be forcibly truncated.
     * 
This method calls https://api.twitter.com/1.1/statuses/update
     *
     * @param status the latest status to be updated.
     * @see POST statuses/update | Twitter Developers
     * @since Twitter4J 2.1.1
     */
    void updateStatus(StatusUpdate status);

    /**
     * Retweets a tweet. Returns the original tweet with retweet details embedded.
     * 
This method calls https://api.twitter.com/1.1/statuses/retweet
     *
     * @param statusId The ID of the status to retweet.
     * @see POST statuses/retweet/:id | Twitter Developers
     * @since Twitter4J 2.0.10
     */
    void retweetStatus(long statusId);

    /**
     * Returns information allowing the creation of an embedded representation of a Tweet on third party sites. See the oEmbed specification for information about the response format.
     * While this endpoint allows a bit of customization for the final appearance of the embedded Tweet, be aware that the appearance of the rendered Tweet may change over time to be consistent with Twitter's Display Requirements. Do not rely on any class or id parameters to stay constant in the returned markup.
     * 
This method calls https://api.twitter.com/1.1/statuses/oembed.json
     * @param req request
     * @see GET statuses/oembed | Twitter Developers
     * @since Twitter4J 3.0.2
     */
    void getOEmbed(OEmbedRequest req);

    /**
     * Returns fully-hydrated tweet objects for up to 100 tweets per request, as specified by comma-separated values passed to the id parameter.
     * This method is especially useful to get the details (hydrate) a collection of Tweet IDs.
     * 
This method calls https://api.twitter.com/1.1/statuses/lookup.json
     *
     * @param ids array of the ids to lookup
     * @see GET statuses/lookup
     * @since Twitter4J 4.0.2
     */
    void lookup(long[] ids);
}