/*
* 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.DirectMessage;
import twitter4j.Paging;
import twitter4j.ResponseList;
import twitter4j.TwitterException;
/**
* @author Joern Huxhorn - jhuxhorn at googlemail.com
*/
public interface DirectMessagesResources {
/**
* Destroys the direct message specified in the required ID parameter. The
* authenticating user must be the recipient of the specified direct
* message. <br>
* This method calls http://api.twitter.com/1.1/direct_messages/destroy
*
* @param id the ID of the direct message to destroy
* @return the deleted direct message
* @throws TwitterException when Twitter service or network is unavailable
* @see <a
* href="https://dev.twitter.com/docs/api/1.1/post/direct_messages/destroy/:id">POST
* direct_messages/destroy/:id | Twitter Developers</a>
* @since Twitter4J 2.0.1
*/
DirectMessage destroyDirectMessage(long id) throws TwitterException;
/**
* Returns a list of the direct messages sent to the authenticating user. <br>
* This method calls http://api.twitter.com/1.1/direct_messages
*
* @return List
* @throws TwitterException when Twitter service or network is unavailable
* @see <a
* href="https://dev.twitter.com/docs/api/1.1/get/direct_messages">GET
* direct_messages | Twitter Developers</a>
*/
ResponseList<DirectMessage> getDirectMessages() throws TwitterException;
/**
* Returns a list of the direct messages sent to the authenticating user. <br>
* This method calls http://api.twitter.com/1.1/direct_messages
*
* @param paging controls pagination. Supports since_id, max_id, count and
* page parameters.
* @return List
* @throws TwitterException when Twitter service or network is unavailable
* @see <a
* href="https://dev.twitter.com/docs/api/1.1/get/direct_messages">GET
* direct_messages | Twitter Developers</a>
*/
ResponseList<DirectMessage> getDirectMessages(Paging paging) throws TwitterException;
/**
* Returns a list of the direct messages sent by the authenticating user. <br>
* This method calls http://api.twitter.com/1.1/direct_messages/sent
*
* @return List
* @throws TwitterException when Twitter service or network is unavailable
* @see <a
* href="https://dev.twitter.com/docs/api/1.1/get/direct_messages/sent">GET
* direct_messages/sent | Twitter Developers</a>
*/
ResponseList<DirectMessage> getSentDirectMessages() throws TwitterException;
/**
* Returns a list of the direct messages sent by the authenticating user. <br>
* This method calls http://api.twitter.com/1.1/direct_messages/sent
*
* @param paging controls pagination. Supports since_id, max_id, count and
* page parameters.
* @return List
* @throws TwitterException when Twitter service or network is unavailable
* @see <a
* href="https://dev.twitter.com/docs/api/1.1/get/direct_messages/sent">GET
* direct_messages/sent | Twitter Developers</a>
* @since Twitter4J 2.0.1
*/
ResponseList<DirectMessage> getSentDirectMessages(Paging paging) throws TwitterException;
DirectMessage sendDirectMessage(long userId, String text) throws TwitterException;
/**
* Sends a new direct message to the specified user from the authenticating
* user. Requires both the user and text parameters below. The text will be
* trimmed if the length of the text is exceeding 140 characters. <br>
* This method calls http://api.twitter.com/1.1/direct_messages/new
*
* @param userId the screen name of the user to whom send the direct message
* @param text The text of your direct message.
* @return DirectMessage
* @throws TwitterException when Twitter service or network is unavailable
* @see <a
* href="https://dev.twitter.com/docs/api/1.1/post/direct_messages/new">POST
* direct_messages/new | Twitter Developers</a>
* @since Twitter4j 2.1.0
*/
DirectMessage sendDirectMessage(long userId, String text, long mediaId) throws TwitterException;
DirectMessage sendDirectMessage(String screenName, String text) throws TwitterException;
/**
* Sends a new direct message to the specified user from the authenticating
* user. Requires both the user and text parameters below. The text will be
* trimmed if the length of the text is exceeding 140 characters. <br>
* This method calls http://api.twitter.com/1.1/direct_messages/new
*
* @param screenName the screen name of the user to whom send the direct
* message
* @param text The text of your direct message.
* @return DirectMessage
* @throws TwitterException when Twitter service or network is unavailable
* @see <a
* href="https://dev.twitter.com/docs/api/1.1/post/direct_messages/new">POST
* direct_messages/new | Twitter Developers</a>
*/
DirectMessage sendDirectMessage(String screenName, String text, long mediaId) throws TwitterException;
/**
* Returns a single direct message, specified by an id parameter. <br>
* This method has not been finalized and the interface is subject to change
* in incompatible ways. <br>
* This method calls
* http://api.twitter.com/1.1/direct_messages/show/:id.json
*
* @param id message id
* @return DirectMessage
* @throws TwitterException when Twitter service or network is unavailable
* @see <a
* href="http://groups.google.com/group/twitter-api-announce/msg/34909da7c399169e">#newtwitter
* and the API - Twitter API Announcements | Google Group</a>
* @since Twitter4J 2.1.9
*/
DirectMessage showDirectMessage(long id) throws TwitterException;
}