Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

TFJ-365 change JavaDoc links from https://apiwiki.twitter.com/* to ht…

  • Loading branch information...
commit fbb18fd22fefde559c6143a924062b036f42c218 1 parent 61760dc
@yusuke authored
Showing with 536 additions and 510 deletions.
  1. +1 −1  twitter4j-core/src/main/java/twitter4j/AsyncTwitter.java
  2. +1 −1  twitter4j-core/src/main/java/twitter4j/Paging.java
  3. +3 −4 twitter4j-core/src/main/java/twitter4j/Query.java
  4. +1 −1  twitter4j-core/src/main/java/twitter4j/RateLimitStatus.java
  5. +1 −1  twitter4j-core/src/main/java/twitter4j/RateLimitStatusEvent.java
  6. +1 −1  twitter4j-core/src/main/java/twitter4j/RateLimitStatusJSONImpl.java
  7. +1 −1  twitter4j-core/src/main/java/twitter4j/Relationship.java
  8. +1 −1  twitter4j-core/src/main/java/twitter4j/RelationshipJSONImpl.java
  9. +2 −1  twitter4j-core/src/main/java/twitter4j/ResponseList.java
  10. +11 −13 twitter4j-core/src/main/java/twitter4j/api/AccountMethods.java
  11. BIN  twitter4j-core/src/main/java/twitter4j/api/AccountMethodsAsync.java
  12. +11 −11 twitter4j-core/src/main/java/twitter4j/api/BlockMethods.java
  13. +12 −12 twitter4j-core/src/main/java/twitter4j/api/BlockMethodsAsync.java
  14. +7 −7 twitter4j-core/src/main/java/twitter4j/api/DirectMessageMethods.java
  15. +8 −8 twitter4j-core/src/main/java/twitter4j/api/DirectMessageMethodsAsync.java
  16. +6 −6 twitter4j-core/src/main/java/twitter4j/api/FavoriteMethods.java
  17. +6 −6 twitter4j-core/src/main/java/twitter4j/api/FavoriteMethodsAsync.java
  18. +26 −20 twitter4j-core/src/main/java/twitter4j/api/FriendshipMethods.java
  19. +26 −20 twitter4j-core/src/main/java/twitter4j/api/FriendshipMethodsAsync.java
  20. +6 −4 twitter4j-core/src/main/java/twitter4j/api/GeoMethods.java
  21. BIN  twitter4j-core/src/main/java/twitter4j/api/GeoMethodsAsync.java
  22. +2 −3 twitter4j-core/src/main/java/twitter4j/api/HelpMethods.java
  23. +1 −1  twitter4j-core/src/main/java/twitter4j/api/HelpMethodsAsync.java
  24. +9 −10 twitter4j-core/src/main/java/twitter4j/api/ListMembersMethods.java
  25. +4 −4 twitter4j-core/src/main/java/twitter4j/api/ListMembersMethodsAsync.java
  26. +15 −16 twitter4j-core/src/main/java/twitter4j/api/ListMethods.java
  27. +14 −14 twitter4j-core/src/main/java/twitter4j/api/ListMethodsAsync.java
  28. +8 −8 twitter4j-core/src/main/java/twitter4j/api/ListSubscribersMethods.java
  29. +8 −8 twitter4j-core/src/main/java/twitter4j/api/ListSubscribersMethodsAsync.java
  30. +4 −4 twitter4j-core/src/main/java/twitter4j/api/LocalTrendsMethods.java
  31. +4 −4 twitter4j-core/src/main/java/twitter4j/api/LocalTrendsMethodsAsync.java
  32. +8 −8 twitter4j-core/src/main/java/twitter4j/api/NotificationMethods.java
  33. +8 −8 twitter4j-core/src/main/java/twitter4j/api/NotificationMethodsAsync.java
  34. +10 −12 twitter4j-core/src/main/java/twitter4j/api/SavedSearchesMethods.java
  35. +35 −41 twitter4j-core/src/main/java/twitter4j/api/SearchMethods.java
  36. +22 −22 twitter4j-core/src/main/java/twitter4j/api/SearchMethodsAsync.java
  37. +12 −12 twitter4j-core/src/main/java/twitter4j/api/SocialGraphMethods.java
  38. +24 −24 twitter4j-core/src/main/java/twitter4j/api/SocialGraphMethodsAsync.java
  39. +2 −2 twitter4j-core/src/main/java/twitter4j/api/SpamReportingMethods.java
  40. +2 −2 twitter4j-core/src/main/java/twitter4j/api/SpamReportingMethodsAsync.java
  41. +26 −29 twitter4j-core/src/main/java/twitter4j/api/StatusMethods.java
  42. BIN  twitter4j-core/src/main/java/twitter4j/api/StatusMethodsAsync.java
  43. +43 −31 twitter4j-core/src/main/java/twitter4j/api/TimelineMethods.java
  44. +44 −32 twitter4j-core/src/main/java/twitter4j/api/TimelineMethodsAsync.java
  45. +52 −52 twitter4j-core/src/main/java/twitter4j/api/UserMethods.java
  46. +42 −38 twitter4j-core/src/main/java/twitter4j/api/UserMethodsAsync.java
  47. +1 −1  twitter4j-core/src/main/java/twitter4j/http/OAuthAuthorization.java
  48. +5 −5 twitter4j-core/src/main/java/twitter4j/http/OAuthSupport.java
View
2  twitter4j-core/src/main/java/twitter4j/AsyncTwitter.java
@@ -1495,7 +1495,7 @@ public void invoke(TwitterListener listener) throws TwitterException {
/**
* {@inheritDoc}
*/
- public void createBlockAsync(final int userId) {
+ public void createBlock(final int userId) {
getDispatcher().invokeLater(new AsyncTask(CREATE_BLOCK, listener) {
public void invoke(TwitterListener listener) throws TwitterException {
listener.createdBlock(twitter.createBlock(userId));
View
2  twitter4j-core/src/main/java/twitter4j/Paging.java
@@ -54,7 +54,7 @@
static final String COUNT = "count";
// somewhat GET list statuses requires "per_page" instead of "count"
- // @see http://apiwiki.twitter.com/Twitter-REST-API-Method%3A-GET-list-statuses
+ // @see <a href="http://dev.twitter.com/doc/get/:user/lists/:id/statuses">GET :user/lists/:id/statuses | dev.twitter.com</a>
static final String PER_PAGE = "per_page";
/*package*/ List<HttpParameter> asPostParameterList() {
View
7 twitter4j-core/src/main/java/twitter4j/Query.java
@@ -35,8 +35,7 @@
* A data class represents search query.<br>
* An instance of this class is NOT thread safe.<br>
* Instances can be shared across threads, but should not be mutated while a search is ongoing.
- * @see <a href="http://apiwiki.twitter.com/Search-API-Documentation">Twitter API / Search API Documentation</a>
- * @see <a href="http://dev.twitter.com/doc/get/search">Twitter API / Recent Search API Documentation</a>
+ * @see <a href="http://dev.twitter.com/doc/get/search">GET search | dev.twitter.com</a>
* @see <a href="http://search.twitter.com/operators">Twitter API / Search Operators</a>
* @author Yusuke Yamamoto - yusuke at mac.com
*/
@@ -71,7 +70,7 @@ public String getQuery() {
/**
* Sets the query string
* @param query the query string
- * @see <a href="http://apiwiki.twitter.com/Search-API-Documentation">Twitter API / Search API Documentation</a>
+ * @see <a href="http://dev.twitter.com/doc/get/search">GET search | dev.twitter.com</a>
* @see <a href="http://search.twitter.com/operators">Twitter API / Search Operators</a>
*/
public void setQuery(String query) {
@@ -82,7 +81,7 @@ public void setQuery(String query) {
* Sets the query string
* @param query the query string
* @return the instance
- * @see <a href="http://apiwiki.twitter.com/Search-API-Documentation">Twitter API / Search API Documentation</a>
+ * @see <a href="http://dev.twitter.com/doc/get/search">GET search | dev.twitter.com</a>
* @see <a href="http://search.twitter.com/operators">Twitter API / Search Operators</a>
* @since Twitter4J 2.1.0
*/
View
2  twitter4j-core/src/main/java/twitter4j/RateLimitStatus.java
@@ -32,7 +32,7 @@
* A data interface representing Twitter REST API's rate limit status
*
* @author Yusuke Yamamoto - yusuke at mac.com
- * @see <a href="http://apiwiki.twitter.com/Rate-limiting">Twitter API Wiki / Rate limiting</a>
+ * @see <a href="http://dev.twitter.com/pages/rate-limiting">Rate Limiting | dev.twitter.com</a>
*/
public interface RateLimitStatus extends java.io.Serializable {
/**
View
2  twitter4j-core/src/main/java/twitter4j/RateLimitStatusEvent.java
@@ -30,7 +30,7 @@
* A data interface representing Twitter REST API's rate limit status
*
* @author Yusuke Yamamoto - yusuke at mac.com
- * @see <a href="http://apiwiki.twitter.com/Rate-limiting">Twitter API Wiki / Rate limiting</a>
+ * @see <a href="http://dev.twitter.com/pages/rate-limiting">Rate Limiting | dev.twitter.com</a>
*/
public final class RateLimitStatusEvent extends java.util.EventObject {
View
2  twitter4j-core/src/main/java/twitter4j/RateLimitStatusJSONImpl.java
@@ -37,7 +37,7 @@
* A data class representing Twitter REST API's rate limit status
*
* @author Yusuke Yamamoto - yusuke at mac.com
- * @see <a href="http://apiwiki.twitter.com/Rate-limiting">Twitter API Wiki / Rate limiting</a>
+ * @see <a href="http://dev.twitter.com/pages/rate-limiting">Rate Limiting | dev.twitter.com</a>
*/
/*package*/ final class RateLimitStatusJSONImpl implements RateLimitStatus, java.io.Serializable {
View
2  twitter4j-core/src/main/java/twitter4j/Relationship.java
@@ -30,7 +30,7 @@
/**
* A data interface that has detailed information about a relationship between two users
* @author Perry Sakkaris - psakkaris at gmail.com
- * @see <a href="http://apiwiki.twitter.com/Twitter-REST-API-Method%3A-friendships-show">REST API DOCUMENTATION</a>
+ * @see <a href="http://dev.twitter.com/doc/get/friendships/show">GET friendships/show | dev.twitter.com</a>
* @since Twitter4J 2.1.0
*/
public interface Relationship extends TwitterResponse, java.io.Serializable {
View
2  twitter4j-core/src/main/java/twitter4j/RelationshipJSONImpl.java
@@ -35,7 +35,7 @@
/**
* A data class that has detailed information about a relationship between two users
* @author Perry Sakkaris - psakkaris at gmail.com
- * @see <a href="http://apiwiki.twitter.com/Twitter-REST-API-Method%3A-friendships-show">REST API DOCUMENTATION</a>
+ * @see <a href="http://dev.twitter.com/doc/get/friendships/show">GET friendships/show | dev.twitter.com</a>
* @since Twitter4J 2.1.0
*/
/*package*/ final class RelationshipJSONImpl extends TwitterResponseImpl implements Relationship, java.io.Serializable {
View
3  twitter4j-core/src/main/java/twitter4j/ResponseList.java
@@ -47,7 +47,8 @@
*
* @return current rate limit status
* @since Twitter4J 2.1.2
- * @see <a href="http://apiwiki.twitter.com/Rate-limiting">Rate limiting</a>
+ * @see <a href="http://dev.twitter.com/pages/rate-limiting">Rate Limiting | dev.twitter.com</a>
+ * @see <a href="http://dev.twitter.com/pages/rate_limiting_faq">Rate Limiting FAQ | dev.twitter.com</a>
*/
public RateLimitStatus getFeatureSpecificRateLimitStatus();
View
24 twitter4j-core/src/main/java/twitter4j/api/AccountMethods.java
@@ -43,7 +43,7 @@
* @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 <a href="http://apiwiki.twitter.com/Twitter-REST-API-Method%3A-account%C2%A0verify_credentials">Twitter API Wiki / Twitter REST API Method: account verify_credentials</a>
+ * @see <a href="http://dev.twitter.com/doc/get/account/verify_credentials">GET account/verify_credentials | dev.twitter.com</a>
*/
User verifyCredentials() throws TwitterException;
@@ -54,27 +54,26 @@
* @return the rate limit status
* @throws TwitterException when Twitter service or network is unavailable
* @since Twitter4J 1.1.4
- * @see <a href="http://apiwiki.twitter.com/Twitter-REST-API-Method%3A-account%C2%A0rate_limit_status">Twitter API Wiki / Twitter REST API Method: account rate_limit_status</a>
+ * @see <a href="http://dev.twitter.com/doc/get/account/rate_limit_status">GET account/rate_limit_status | dev.twitter.com</a>
*/
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.
+ * Sets which device Twitter delivers updates to for the authenticating user. Sending none as the device parameter will disable IM or SMS updates.
* <br>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 <a href="http://apiwiki.twitter.com/Twitter-REST-API-Method%3A-account%C2%A0update_delivery_device">Twitter API Wiki / Twitter REST API Method: account update_delivery_device</a>
+ * @see <a href="http://dev.twitter.com/doc/post/account/update_delivery_device">POST account/update_delivery_device | dev.twitter.com</a>
*/
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 verifyCredentials() method.
+ * Sets one or more hex values that control the color scheme of the authenticating user's profile page on twitter.com. Each parameter's value must be a valid hexidecimal value, and may be either three or six characters (ex: #fff or #ffffff).
* <br>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
@@ -84,7 +83,7 @@ User updateDeliveryDevice(Device device)
* @return the updated user
* @throws TwitterException when Twitter service or network is unavailable
* @since Twitter4J 2.0.0
- * @see <a href="http://apiwiki.twitter.com/Twitter-REST-API-Method%3A-account%C2%A0update_profile_colors">Twitter API Wiki / Twitter REST API Method: account update_profile_colors</a>
+ * @see <a href="http://dev.twitter.com/doc/post/account/update_profile_colors">POST account/update_profile_colors | dev.twitter.com</a>
*/
User updateProfileColors(String profileBackgroundColor, String profileTextColor, String profileLinkColor, String profileSidebarFillColor, String profileSidebarBorderColor)
throws TwitterException;
@@ -98,12 +97,11 @@ User updateProfileColors(String profileBackgroundColor, String profileTextColor,
* 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 <a href="http://apiwiki.twitter.com/Twitter-REST-API-Method%3A-account%C2%A0update_profile_image">Twitter API Wiki / Twitter REST API Method: account update_profile_image</a>
+ * @see <a href="http://dev.twitter.com/doc/post/account/update_profile_image">POST account/update_profile_image | dev.twitter.com</a>
*/
- User updateProfileImage(File image)
- throws TwitterException;
+ User updateProfileImage(File image) throws TwitterException;
- /**
+ /**
* Updates the authenticating user's profile background image.
* <br>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.
@@ -113,7 +111,7 @@ User updateProfileImage(File image)
* 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 <a href="http://apiwiki.twitter.com/Twitter-REST-API-Method%3A-account%C2%A0update_profile_background_image">Twitter API Wiki / Twitter REST API Method: account update_profile_background_image</a>
+ * @see <a href="http://dev.twitter.com/doc/post/account/update_profile_background_image">POST account/update_profile_background_image | dev.twitter.com</a>
*/
User updateProfileBackgroundImage(File image, boolean tile)
throws TwitterException;
@@ -130,7 +128,7 @@ User updateProfileBackgroundImage(File image, boolean tile)
* @return the updated user
* @throws TwitterException when Twitter service or network is unavailable
* @since Twitter4J 2.0.2
- * @see <a href="http://apiwiki.twitter.com/Twitter-REST-API-Method%3A-account%C2%A0update_profile">Twitter REST API Documentation &gt; Account Methods &gt; account/update_location</a>
+ * @see <a href="http://dev.twitter.com/doc/post/account/update_profile">POST account/update_profile | dev.twitter.com</a>
*/
User updateProfile(String name, String email, String url, String location, String description)
throws TwitterException;
View
BIN  twitter4j-core/src/main/java/twitter4j/api/AccountMethodsAsync.java
Binary file not shown
View
22 twitter4j-core/src/main/java/twitter4j/api/BlockMethods.java
@@ -43,7 +43,7 @@
* @return the blocked user
* @throws TwitterException when Twitter service or network is unavailable
* @since Twitter4J 2.0.1
- * @see <a href="http://apiwiki.twitter.com/Twitter-REST-API-Method%3A-blocks%C2%A0create">Twitter API Wiki / Twitter REST API Method: blocks create</a>
+ * @see <a href="http://dev.twitter.com/doc/post/blocks/create">POST blocks/create | dev.twitter.com</a>
*/
User createBlock(String screenName) throws TwitterException;
@@ -55,7 +55,7 @@
* @return the blocked user
* @throws TwitterException when Twitter service or network is unavailable
* @since Twitter4J 2.1.0
- * @see <a href="http://apiwiki.twitter.com/Twitter-REST-API-Method%3A-blocks%C2%A0create">Twitter API Wiki / Twitter REST API Method: blocks create</a>
+ * @see <a href="http://dev.twitter.com/doc/post/blocks/create">POST blocks/create | dev.twitter.com</a>
*/
User createBlock(int userId) throws TwitterException;
@@ -67,7 +67,7 @@
* @return the unblocked user
* @throws TwitterException when Twitter service or network is unavailable
* @since Twitter4J 2.0.1
- * @see <a href="http://apiwiki.twitter.com/Twitter-REST-API-Method%3A-blocks%C2%A0destroy">Twitter API Wiki / Twitter REST API Method: blocks destroy</a>
+ * @see <a href="http://dev.twitter.com/doc/post/blocks/destroy">POST blocks/destroy | dev.twitter.com</a>
*/
User destroyBlock(String screen_name) throws TwitterException;
@@ -79,31 +79,31 @@
* @return the unblocked user
* @throws TwitterException when Twitter service or network is unavailable
* @since Twitter4J 2.0.1
- * @see <a href="http://apiwiki.twitter.com/Twitter-REST-API-Method%3A-blocks%C2%A0destroy">Twitter API Wiki / Twitter REST API Method: blocks destroy</a>
+ * @see <a href="http://dev.twitter.com/doc/post/blocks/destroy">POST blocks/destroy | dev.twitter.com</a>
*/
User destroyBlock(int userId) throws TwitterException;
/**
- * Tests if a friendship exists between two users.
+ * Returns if the authenticating user is blocking a target user. Will return the blocked user's object if a block exists, and error with a HTTP 404 response code otherwise.
* <br>This method calls http://api.twitter.com/1/blocks/exists/[id].json
*
* @param screenName The screen_name of the potentially blocked user.
* @return if the authenticating user is blocking a target user
* @throws TwitterException when Twitter service or network is unavailable
* @since Twitter4J 2.0.4
- * @see <a href="http://apiwiki.twitter.com/Twitter-REST-API-Method%3A-blocks-exists">Twitter API Wiki / Twitter REST API Method: blocks exists</a>
+ * @see <a href="http://dev.twitter.com/doc/get/blocks/exists">GET blocks/exists | dev.twitter.com</a>
*/
boolean existsBlock(String screenName) throws TwitterException;
/**
- * Tests if a friendship exists between two users.
+ * Returns if the authenticating user is blocking a target user. Will return the blocked user's object if a block exists, and error with a HTTP 404 response code otherwise.
* <br>This method calls http://api.twitter.com/1/blocks/exists/[id].json
*
* @param userId The ID of the potentially blocked user.
* @return if the authenticating user is blocking a target user
* @throws TwitterException when Twitter service or network is unavailable
* @since Twitter4J 2.1.0
- * @see <a href="http://apiwiki.twitter.com/Twitter-REST-API-Method%3A-blocks-exists">Twitter API Wiki / Twitter REST API Method: blocks exists</a>
+ * @see <a href="http://dev.twitter.com/doc/get/blocks/exists">GET blocks/exists | dev.twitter.com</a>
*/
boolean existsBlock(int userId) throws TwitterException;
@@ -114,7 +114,7 @@
* @return a list of user objects that the authenticating user
* @throws TwitterException when Twitter service or network is unavailable
* @since Twitter4J 2.0.4
- * @see <a href="http://apiwiki.twitter.com/Twitter-REST-API-Method%3A-blocks-blocking">Twitter API Wiki / Twitter REST API Method: blocks blocking</a>
+ * @see <a href="http://dev.twitter.com/doc/get/blocks/blocking">GET blocks/blocking | dev.twitter.com</a>
*/
ResponseList<User> getBlockingUsers() throws TwitterException;
@@ -126,7 +126,7 @@
* @return a list of user objects that the authenticating user
* @throws TwitterException when Twitter service or network is unavailable
* @since Twitter4J 2.0.4
- * @see <a href="http://apiwiki.twitter.com/Twitter-REST-API-Method%3A-blocks-blocking">Twitter API Wiki / Twitter REST API Method: blocks blocking</a>
+ * @see <a href="http://dev.twitter.com/doc/get/blocks/blocking">GET blocks/blocking | dev.twitter.com</a>
*/
ResponseList<User> getBlockingUsers(int page) throws TwitterException;
@@ -136,7 +136,7 @@
* @return Returns an array of numeric user ids the authenticating user is blocking.
* @throws TwitterException when Twitter service or network is unavailable
* @since Twitter4J 2.0.4
- * @see <a href="http://apiwiki.twitter.com/Twitter-REST-API-Method%3A-blocks-blocking-ids">Twitter API Wiki / Twitter REST API Method: blocks blocking ids</a>
+ * @see <a href="http://dev.twitter.com/doc/get/blocks/blocking/ids">GET blocks/blocking/ids | dev.twitter.com</a>
*/
IDs getBlockingUsersIDs() throws TwitterException;
}
View
24 twitter4j-core/src/main/java/twitter4j/api/BlockMethodsAsync.java
@@ -36,7 +36,7 @@
*
* @param screenName the screen_name of the user to block
* @since Twitter4J 2.0.1
- * @see <a href="http://apiwiki.twitter.com/Twitter-REST-API-Method:-blocks%C2%A0create">Twitter API Wiki / Twitter REST API Method: blocks%C2%A0create</a>
+ * @see <a href="http://dev.twitter.com/doc/post/blocks/create">POST blocks/create | dev.twitter.com</a>
*/
void createBlock(String screenName);
@@ -46,9 +46,9 @@
*
* @param userId the screen_name of the user to block
* @since Twitter4J 2.1.0
- * @see <a href="http://apiwiki.twitter.com/Twitter-REST-API-Method:-blocks%C2%A0create">Twitter API Wiki / Twitter REST API Method: blocks%C2%A0create</a>
+ * @see <a href="http://dev.twitter.com/doc/post/blocks/create">POST blocks/create | dev.twitter.com</a>
*/
- void createBlockAsync(int userId);
+ void createBlock(int userId);
/**
* Un-blocks the user specified in the ID parameter as the authenticating user. Returns the un-blocked user in the requested format when successful.
@@ -56,7 +56,7 @@
*
* @param screenName the screen_name of the user to block
* @since Twitter4J 2.0.1
- * @see <a href="http://apiwiki.twitter.com/Twitter-REST-API-Method:-blocks%C2%A0destroy">Twitter API Wiki / Twitter REST API Method: blocks%C2%A0destroy</a>
+ * @see <a href="http://dev.twitter.com/doc/post/blocks/destroy">POST blocks/destroy | dev.twitter.com</a>
*/
void destroyBlock(String screenName);
@@ -66,27 +66,27 @@
*
* @param userId the ID of the user to block
* @since Twitter4J 2.1.0
- * @see <a href="http://apiwiki.twitter.com/Twitter-REST-API-Method:-blocks%C2%A0destroy">Twitter API Wiki / Twitter REST API Method: blocks%C2%A0destroy</a>
+ * @see <a href="http://dev.twitter.com/doc/post/blocks/destroy">POST blocks/destroy | dev.twitter.com</a>
*/
void destroyBlock(int userId);
/**
- * Tests if a friendship exists between two users.
+ * Returns if the authenticating user is blocking a target user. Will return the blocked user's object if a block exists, and error with a HTTP 404 response code otherwise.
* <br>This method calls http://api.twitter.com/1/blocks/exists/id.xml
*
* @param screenName The screen_name of the potentially blocked user.
* @since Twitter4J 2.0.4
- * @see <a href="http://apiwiki.twitter.com/Twitter-REST-API-Method%3A-blocks-exists">Twitter API Wiki / Twitter REST API Method: blocks exists</a>
+ * @see <a href="http://dev.twitter.com/doc/get/blocks/exists">GET blocks/exists | dev.twitter.com</a>
*/
void existsBlock(String screenName);
/**
- * Tests if a friendship exists between two users.
+ * Returns if the authenticating user is blocking a target user. Will return the blocked user's object if a block exists, and error with a HTTP 404 response code otherwise.
* <br>This method calls http://api.twitter.com/1/blocks/exists/id.xml
*
* @param userId The ID of the potentially blocked user.
* @since Twitter4J 2.1.0
- * @see <a href="http://apiwiki.twitter.com/Twitter-REST-API-Method%3A-blocks-exists">Twitter API Wiki / Twitter REST API Method: blocks exists</a>
+ * @see <a href="http://dev.twitter.com/doc/get/blocks/exists">GET blocks/exists | dev.twitter.com</a>
*/
void existsBlock(int userId);
@@ -95,7 +95,7 @@
* <br>This method calls http://api.twitter.com/1/blocks/blocking.xml
*
* @since Twitter4J 2.0.4
- * @see <a href="http://apiwiki.twitter.com/Twitter-REST-API-Method%3A-blocks-blocking">Twitter API Wiki / Twitter REST API Method: blocks blocking</a>
+ * @see <a href="http://dev.twitter.com/doc/get/blocks/blocking">GET blocks/blocking | dev.twitter.com</a>
*/
void getBlockingUsers();
@@ -105,7 +105,7 @@
*
* @param page the number of page
* @since Twitter4J 2.0.4
- * @see <a href="http://apiwiki.twitter.com/Twitter-REST-API-Method%3A-blocks-blocking">Twitter API Wiki / Twitter REST API Method: blocks blocking</a>
+ * @see <a href="http://dev.twitter.com/doc/get/blocks/blocking">GET blocks/blocking | dev.twitter.com</a>
*/
void getBlockingUsers(int page);
@@ -113,7 +113,7 @@
* Returns an array of numeric user ids the authenticating user is blocking.
* <br>This method calls http://api.twitter.com/1/blocks/blocking/ids
* @since Twitter4J 2.0.4
- * @see <a href="http://apiwiki.twitter.com/Twitter-REST-API-Method%3A-blocks-blocking-ids">Twitter API Wiki / Twitter REST API Method: blocks blocking ids</a>
+ * @see <a href="http://dev.twitter.com/doc/get/blocks/blocking/ids">GET blocks/blocking/ids | dev.twitter.com</a>
*/
void getBlockingUsersIDs();
}
View
14 twitter4j-core/src/main/java/twitter4j/api/DirectMessageMethods.java
@@ -41,7 +41,7 @@
*
* @return List
* @throws TwitterException when Twitter service or network is unavailable
- * @see <a href="http://apiwiki.twitter.com/Twitter-REST-API-Method%3A-direct_messages">Twitter API Wiki / Twitter REST API Method: direct_messages</a>
+ * @see <a href="http://dev.twitter.com/doc/get/direct_messages">GET direct_messages | dev.twitter.com</a>
*/
ResponseList<DirectMessage> getDirectMessages()
throws TwitterException;
@@ -53,7 +53,7 @@
* @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="http://apiwiki.twitter.com/Twitter-REST-API-Method%3A-direct_messages">Twitter API Wiki / Twitter REST API Method: direct_messages</a>
+ * @see <a href="http://dev.twitter.com/doc/get/direct_messages">GET direct_messages | dev.twitter.com</a>
*/
ResponseList<DirectMessage> getDirectMessages(Paging paging)
throws TwitterException;
@@ -63,7 +63,7 @@
*
* @return List
* @throws TwitterException when Twitter service or network is unavailable
- * @see <a href="http://apiwiki.twitter.com/Twitter-REST-API-Method%3A-direct_messages%C2%A0sent">Twitter API Wiki / Twitter REST API Method: direct_messages sent</a>
+ * @see <a href="http://dev.twitter.com/doc/get/direct_messages/sent">GET direct_messages/sent | dev.twitter.com</a>
*/
ResponseList<DirectMessage> getSentDirectMessages()
throws TwitterException;
@@ -76,7 +76,7 @@
* @return List
* @throws TwitterException when Twitter service or network is unavailable
* @since Twitter4J 2.0.1
- * @see <a href="http://apiwiki.twitter.com/Twitter-REST-API-Method%3A-direct_messages%C2%A0sent">Twitter API Wiki / Twitter REST API Method: direct_messages sent</a>
+ * @see <a href="http://dev.twitter.com/doc/get/direct_messages/sent">GET direct_messages/sent | dev.twitter.com</a>
*/
ResponseList<DirectMessage> getSentDirectMessages(Paging paging)
throws TwitterException;
@@ -91,7 +91,7 @@
* @param text The text of your direct message.
* @return DirectMessage
* @throws TwitterException when Twitter service or network is unavailable
- * @see <a href="http://apiwiki.twitter.com/Twitter-REST-API-Method%3A-direct_messages%C2%A0new">Twitter API Wiki / Twitter REST API Method: direct_messages new</a>
+ * @see <a href="http://dev.twitter.com/doc/post/direct_messages/new">POST direct_messages/new | dev.twitter.com</a>
*/
DirectMessage sendDirectMessage(String screenName, String text)
throws TwitterException;
@@ -105,7 +105,7 @@ DirectMessage sendDirectMessage(String screenName, String text)
* @param text The text of your direct message.
* @return DirectMessage
* @throws TwitterException when Twitter service or network is unavailable
- * @see <a href="http://apiwiki.twitter.com/Twitter-REST-API-Method%3A-direct_messages%C2%A0new">Twitter API Wiki / Twitter REST API Method: direct_messages new</a>
+ * @see <a href="http://dev.twitter.com/doc/post/direct_messages/new">POST direct_messages/new | dev.twitter.com</a>
* @since Twitter4j 2.1.0
*/
DirectMessage sendDirectMessage(int userId, String text)
@@ -118,7 +118,7 @@ DirectMessage sendDirectMessage(int userId, String text)
* @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="http://apiwiki.twitter.com/Twitter-REST-API-Method%3A-direct_messages%C2%A0destroy">Twitter API Wiki / Twitter REST API Method: direct_messages destroy</a>
+ * @see <a href="http://dev.twitter.com/doc/post/direct_messages/destroy">POST direct_messages/destroy | dev.twitter.com</a>
* @since Twitter4J 2.0.1
*/
DirectMessage destroyDirectMessage(int id)
View
16 twitter4j-core/src/main/java/twitter4j/api/DirectMessageMethodsAsync.java
@@ -35,7 +35,7 @@
/**
* Returns a list of the direct messages sent to the authenticating user.
* <br>This method calls http://api.twitter.com/1/direct_messages
- * @see <a href="http://apiwiki.twitter.com/Twitter-REST-API-Method:-direct_messages">Twitter API Wiki / Twitter REST API Method: direct_messages</a>
+ * @see <a href="http://dev.twitter.com/doc/get/direct_messages">GET direct_messages | dev.twitter.com</a>
*/
void getDirectMessages();
@@ -44,14 +44,14 @@
* <br>This method calls http://api.twitter.com/1/direct_messages
* @param paging controls pagination
* @since Twitter4J 2.0.1
- * @see <a href="http://apiwiki.twitter.com/Twitter-REST-API-Method:-direct_messages">Twitter API Wiki / Twitter REST API Method: direct_messages</a>
+ * @see <a href="http://dev.twitter.com/doc/get/direct_messages">GET direct_messages | dev.twitter.com</a>
*/
void getDirectMessages(Paging paging);
/**
* Returns a list of the direct messages sent by the authenticating user.
* <br>This method calls http://api.twitter.com/1/direct_messages/sent
- * @see <a href="http://apiwiki.twitter.com/Twitter-REST-API-Method:-direct_messages%C2%A0sent">Twitter API Wiki / Twitter REST API Method: direct_messages%C2%A0sent</a>
+ * @see <a href="http://dev.twitter.com/doc/get/direct_messages/sent">GET direct_messages/sent | dev.twitter.com</a>
*/
void getSentDirectMessages();
@@ -60,7 +60,7 @@
* <br>This method calls http://api.twitter.com/1/direct_messages/sent
* @param paging controls pagination
* @since Twitter4J 2.0.1
- * @see <a href="http://apiwiki.twitter.com/Twitter-REST-API-Method:-direct_messages%C2%A0sent">Twitter API Wiki / Twitter REST API Method: direct_messages%C2%A0sent</a>
+ * @see <a href="http://dev.twitter.com/doc/get/direct_messages/sent">GET direct_messages/sent | dev.twitter.com</a>
*/
void getSentDirectMessages(Paging paging);
@@ -70,7 +70,7 @@
* <br>This method calls http://api.twitter.com/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.
- * @see <a href="http://apiwiki.twitter.com/Twitter-REST-API-Method:-direct_messages%C2%A0new">Twitter API Wiki / Twitter REST API Method: direct_messages%C2%A0new</a>
+ * @see <a href="http://dev.twitter.com/doc/post/direct_messages/new">POST direct_messages/new | dev.twitter.com</a>
*/
void sendDirectMessage(String screenName, String text);
@@ -80,16 +80,16 @@
* <br>This method calls http://api.twitter.com/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.
- * @see <a href="http://apiwiki.twitter.com/Twitter-REST-API-Method:-direct_messages%C2%A0new">Twitter API Wiki / Twitter REST API Method: direct_messages%C2%A0new</a>
+ * @see <a href="http://dev.twitter.com/doc/post/direct_messages/new">POST direct_messages/new | dev.twitter.com</a>
* @since Twitter4j 2.1.0
*/
void sendDirectMessage(int userId, String text);
/**
- * Delete specified direct message
+ * 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/direct_messages/destroy
* @param id int
- * @see <a href="http://apiwiki.twitter.com/Twitter-REST-API-Method:-direct_messages%C2%A0destroy">Twitter API Wiki / Twitter REST API Method: direct_messages%C2%A0destroy</a>
+ * @see <a href="http://dev.twitter.com/doc/post/direct_messages/destroy">POST direct_messages/destroy | dev.twitter.com</a>
* @since Twitter4J 2.0.1
*/
void destroyDirectMessage(int id);
View
12 twitter4j-core/src/main/java/twitter4j/api/FavoriteMethods.java
@@ -40,7 +40,7 @@
*
* @return List<Status>
* @throws TwitterException when Twitter service or network is unavailable
- * @see <a href="http://apiwiki.twitter.com/Twitter-REST-API-Method%3A-favorites">Twitter API Wiki / Twitter REST API Method: favorites</a>
+ * @see <a href="http://dev.twitter.com/doc/get/favorites">GET favorites | dev.twitter.com</a>
* @since Twitter4J 2.0.1
*/
ResponseList<Status> getFavorites()
@@ -53,7 +53,7 @@
* @param page the number of page
* @return ResponseList<Status>
* @throws TwitterException when Twitter service or network is unavailable
- * @see <a href="http://apiwiki.twitter.com/Twitter-REST-API-Method%3A-favorites">Twitter API Wiki / Twitter REST API Method: favorites</a>
+ * @see <a href="http://dev.twitter.com/doc/get/favorites">GET favorites | dev.twitter.com</a>
* @since Twitter4J 2.0.1
*/
ResponseList<Status> getFavorites(int page)
@@ -65,7 +65,7 @@
* @param id the ID or screen name of the user for whom to request a list of favorite statuses
* @return ResponseList<Status>
* @throws TwitterException when Twitter service or network is unavailable
- * @see <a href="http://apiwiki.twitter.com/Twitter-REST-API-Method%3A-favorites">Twitter API Wiki / Twitter REST API Method: favorites</a>
+ * @see <a href="http://dev.twitter.com/doc/get/favorites">GET favorites | dev.twitter.com</a>
* @since Twitter4J 2.0.1
*/
ResponseList<Status> getFavorites(String id)
@@ -80,7 +80,7 @@
* @return ResponseList<Status>
* @throws TwitterException when Twitter service or network is unavailable
* @since Twitter4J 2.0.1
- * @see <a href="http://apiwiki.twitter.com/Twitter-REST-API-Method%3A-favorites">Twitter API Wiki / Twitter REST API Method: favorites</a>
+ * @see <a href="http://dev.twitter.com/doc/get/favorites">GET favorites | dev.twitter.com</a>
*/
ResponseList<Status> getFavorites(String id, int page)
throws TwitterException;
@@ -92,7 +92,7 @@
* @param id the ID of the status to favorite
* @return Status
* @throws TwitterException when Twitter service or network is unavailable
- * @see <a href="http://apiwiki.twitter.com/Twitter-REST-API-Method%3A-favorites%C2%A0create">Twitter API Wiki / Twitter REST API Method: favorites create</a>
+ * @see <a href="http://dev.twitter.com/doc/post/favorites/:id/create">POST favorites/:id/create | dev.twitter.com</a>
*/
Status createFavorite(long id)
throws TwitterException;
@@ -104,7 +104,7 @@ Status createFavorite(long id)
* @param id the ID of the status to un-favorite
* @return Status
* @throws TwitterException when Twitter service or network is unavailable
- * @see <a href="http://apiwiki.twitter.com/Twitter-REST-API-Method%3A-favorites%C2%A0destroy">Twitter API Wiki / Twitter REST API Method: favorites destroy</a>
+ * @see <a href="http://dev.twitter.com/doc/post/favorites/destroy">POST favorites/destroy | dev.twitter.com</a>
*/
Status destroyFavorite(long id)
throws TwitterException;
View
12 twitter4j-core/src/main/java/twitter4j/api/FavoriteMethodsAsync.java
@@ -33,7 +33,7 @@
/**
* Returns the 20 most recent favorite statuses for the authenticating user or user specified by the ID parameter in the requested format.
* <br>This method calls http://api.twitter.com/1/favorites
- * @see <a href="http://apiwiki.twitter.com/Twitter-REST-API-Method:-favorites">Twitter API Wiki / Twitter REST API Method: favorites</a>
+ * @see <a href="http://dev.twitter.com/doc/get/favorites">GET favorites | dev.twitter.com</a>
* @since Twitter4J 2.0.1
*/
void getFavorites();
@@ -42,7 +42,7 @@
* Returns the 20 most recent favorite statuses for the authenticating user or user specified by the ID parameter in the requested format.
* <br>This method calls http://api.twitter.com/1/favorites
* @param page number of page to retrieve favorites
- * @see <a href="http://apiwiki.twitter.com/Twitter-REST-API-Method:-favorites">Twitter API Wiki / Twitter REST API Method: favorites</a>
+ * @see <a href="http://dev.twitter.com/doc/get/favorites">GET favorites | dev.twitter.com</a>
* @since Twitter4J 2.0.1
*/
void getFavorites(int page);
@@ -51,7 +51,7 @@
* Returns the 20 most recent favorite statuses for the authenticating user or user specified by the ID parameter in the requested format.
* <br>This method calls http://api.twitter.com/1/favorites
* @param id the ID or screen name of the user for whom to request a list of favorite statuses
- * @see <a href="http://apiwiki.twitter.com/Twitter-REST-API-Method:-favorites">Twitter API Wiki / Twitter REST API Method: favorites</a>
+ * @see <a href="http://dev.twitter.com/doc/get/favorites">GET favorites | dev.twitter.com</a>
* @since Twitter4J 2.0.1
*/
void getFavorites(String id);
@@ -61,7 +61,7 @@
* <br>This method calls http://api.twitter.com/1/favorites
* @param id the ID or screen name of the user for whom to request a list of favorite statuses.
* @param page retrieves the 20 next most recent favorite statuses.
- * @see <a href="http://apiwiki.twitter.com/Twitter-REST-API-Method:-favorites">Twitter API Wiki / Twitter REST API Method: favorites</a>
+ * @see <a href="http://dev.twitter.com/doc/get/favorites">GET favorites | dev.twitter.com</a>
* @since Twitter4J 2.0.1
*/
void getFavorites(String id,int page);
@@ -72,7 +72,7 @@
*
* @param id the ID or screen name of the user for whom to request a list of favorite statuses.
* @since 1.1.2
- * @see <a href="http://apiwiki.twitter.com/Twitter-REST-API-Method:-favorites%C2%A0create">Twitter API Wiki / Twitter REST API Method: favorites%C2%A0create</a>
+ * @see <a href="http://dev.twitter.com/doc/post/favorites/:id/create">POST favorites/:id/create | dev.twitter.com</a>
*/
void createFavorite(long id);
@@ -82,7 +82,7 @@
*
* @param id the ID or screen name of the user for whom to request a list of un-favorite statuses.
* @since 1.1.2
- * @see <a href="http://apiwiki.twitter.com/Twitter-REST-API-Method:-favorites%C2%A0destroy">Twitter API Wiki / Twitter REST API Method: favorites%C2%A0destroy</a>
+ * @see <a href="http://dev.twitter.com/doc/post/favorites/destroy">POST favorites/destroy | dev.twitter.com</a>
*/
void destroyFavorite(long id);
}
View
46 twitter4j-core/src/main/java/twitter4j/api/FriendshipMethods.java
@@ -36,32 +36,35 @@
*/
public interface FriendshipMethods {
/**
- * Befriends the user specified in the ID parameter as the authenticating user. Returns the befriended user in the requested format when successful. Returns a string describing the failure condition when unsuccessful.
+ * Allows the authenticating users to follow the user specified in the ID parameter.<br>
+ * Returns the befriended user in the requested format when successful. Returns a string describing the failure condition when unsuccessful. If you are already friends with the user an HTTP 403 will be returned.
* <br>This method calls http://api.twitter.com/1/friendships/create/[id].json
*
* @param screenName the screen name of the user to be befriended
* @return the befriended user
* @throws twitter4j.TwitterException when Twitter service or network is unavailable
* @since Twitter4J 2.0.1
- * @see <a href="http://apiwiki.twitter.com/Twitter-REST-API-Method%3A-friendships%C2%A0create">Twitter API Wiki / Twitter REST API Method: friendships create</a>
+ * @see <a href="http://dev.twitter.com/doc/post/friendships/create/:id">POST friendships/create/:id | dev.twitter.com</a>
*/
User createFriendship(String screenName)
throws TwitterException;
/**
- * Befriends the user specified in the ID parameter as the authenticating user. Returns the befriended user in the requested format when successful. Returns a string describing the failure condition when unsuccessful.
+ * Allows the authenticating users to follow the user specified in the ID parameter.<br>
+ * Returns the befriended user in the requested format when successful. Returns a string describing the failure condition when unsuccessful. If you are already friends with the user an HTTP 403 will be returned.
* <br>This method calls http://api.twitter.com/1/friendships/create/[id].json
*
* @param userId the ID of the user to be befriended
* @return the befriended user
* @throws TwitterException when Twitter service or network is unavailable
* @since Twitter4J 2.1.0
- * @see <a href="http://apiwiki.twitter.com/Twitter-REST-API-Method%3A-friendships%C2%A0create">Twitter API Wiki / Twitter REST API Method: friendships create</a>
+ * @see <a href="http://dev.twitter.com/doc/post/friendships/create/:id">POST friendships/create/:id | dev.twitter.com</a>
*/
User createFriendship(int userId)
throws TwitterException;
/**
- * Befriends the user specified in the ID parameter as the authenticating user. Returns the befriended user in the requested format when successful. Returns a string describing the failure condition when unsuccessful.
+ * Allows the authenticating users to follow the user specified in the ID parameter.<br>
+ * Returns the befriended user in the requested format when successful. Returns a string describing the failure condition when unsuccessful. If you are already friends with the user an HTTP 403 will be returned.
* <br>This method calls http://api.twitter.com/1/friendships/create/[id].json
*
* @param screenName the screen name of the user to be befriended
@@ -69,13 +72,14 @@ User createFriendship(int userId)
* @return the befriended user
* @throws TwitterException when Twitter service or network is unavailable
* @since Twitter4J 2.0.2
- * @see <a href="http://apiwiki.twitter.com/Twitter-REST-API-Method%3A-friendships%C2%A0create">Twitter API Wiki / Twitter REST API Method: friendships create</a>
+ * @see <a href="http://dev.twitter.com/doc/post/friendships/create/:id">POST friendships/create/:id | dev.twitter.com</a>
*/
User createFriendship(String screenName, boolean follow)
throws TwitterException;
/**
- * Befriends the user specified in the ID parameter as the authenticating user. Returns the befriended user in the requested format when successful. Returns a string describing the failure condition when unsuccessful.
+ * Allows the authenticating users to follow the user specified in the ID parameter.<br>
+ * Returns the befriended user in the requested format when successful. Returns a string describing the failure condition when unsuccessful. If you are already friends with the user an HTTP 403 will be returned.
* <br>This method calls http://api.twitter.com/1/friendships/create/[id].json
*
* @param userId the ID of the user to be befriended
@@ -83,39 +87,41 @@ User createFriendship(String screenName, boolean follow)
* @return the befriended user
* @throws TwitterException when Twitter service or network is unavailable
* @since Twitter4J 2.1.0
- * @see <a href="http://apiwiki.twitter.com/Twitter-REST-API-Method%3A-friendships%C2%A0create">Twitter API Wiki / Twitter REST API Method: friendships create</a>
+ * @see <a href="http://dev.twitter.com/doc/post/friendships/create/:id">POST friendships/create/:id | dev.twitter.com</a>
*/
User createFriendship(int userId, boolean follow)
throws TwitterException;
/**
- * Discontinues friendship with the user specified in the ID parameter as the authenticating user. Returns the un-friended user in the requested format when successful. Returns a string describing the failure condition when unsuccessful.
+ * Allows the authenticating users to unfollow the user specified in the ID parameter.<br>
+ * Returns the unfollowed user in the requested format when successful. Returns a string describing the failure condition when unsuccessful.
* <br>This method calls http://api.twitter.com/1/friendships/destroy/[id].json
*
* @param screenName the screen name of the user for whom to request a list of friends
* @return User
* @throws TwitterException when Twitter service or network is unavailable
* @since Twitter4J 2.0.1
- * @see <a href="http://apiwiki.twitter.com/Twitter-REST-API-Method%3A-friendships%C2%A0destroy">Twitter API Wiki / Twitter REST API Method: friendships destroy</a>
+ * @see <a href="http://dev.twitter.com/doc/post/friendships/destroy">POST friendships/destroy | dev.twitter.com</a>
*/
User destroyFriendship(String screenName)
throws TwitterException;
/**
- * Discontinues friendship with the user specified in the ID parameter as the authenticating user. Returns the un-friended user in the requested format when successful. Returns a string describing the failure condition when unsuccessful.
+ * Allows the authenticating users to unfollow the user specified in the ID parameter.<br>
+ * Returns the unfollowed user in the requested format when successful. Returns a string describing the failure condition when unsuccessful.
* <br>This method calls http://api.twitter.com/1/friendships/destroy/[id].json
*
* @param userId the ID of the user for whom to request a list of friends
* @return User
* @throws TwitterException when Twitter service or network is unavailable
- * @see <a href="http://apiwiki.twitter.com/Twitter-REST-API-Method%3A-friendships%C2%A0destroy">Twitter API Wiki / Twitter REST API Method: friendships destroy</a>
+ * @see <a href="http://dev.twitter.com/doc/post/friendships/destroy">POST friendships/destroy | dev.twitter.com</a>
* @since Twitter4J 2.1.0
*/
User destroyFriendship(int userId)
throws TwitterException;
/**
- * Tests if a friendship exists between two users.
+ * Tests for the existence of friendship between two users. Will return true if user_a follows user_b, otherwise will return false.
* <br>This method calls http://api.twitter.com/1/friendships/exists.json
*
* @param userA The ID or screen_name of the first user to test friendship for.
@@ -123,13 +129,13 @@ User destroyFriendship(int userId)
* @return if a friendship exists between two users.
* @throws TwitterException when Twitter service or network is unavailable
* @since Twitter4J 2.0.1
- * @see <a href="http://apiwiki.twitter.com/Twitter-REST-API-Method%3A-friendships-exists">Twitter API Wiki / Twitter REST API Method: friendships exists</a>
+ * @see <a href="http://dev.twitter.com/doc/get/friendships/exists">GET friendships/exists | dev.twitter.com</a>
*/
boolean existsFriendship(String userA, String userB)
throws TwitterException;
/**
- * Gets the detailed relationship status between a source user and a target user
+ * Returns detailed information about the relationship between two users.
* <br>This method calls http://api.twitter.com/1/friendships/show.json
* @param sourceScreenName the screen name of the source user
* @param targetScreenName the screen name of the target user
@@ -137,13 +143,13 @@ boolean existsFriendship(String userA, String userB)
*
* @throws TwitterException when Twitter service or network is unavailable
* @since Twitter4J 2.1.0
- * @see <a href="http://apiwiki.twitter.com/Twitter-REST-API-Method%3A-friendships-show">Twitter API Wiki / Twitter REST API Method: friendships show</a>
+ * @see <a href="http://dev.twitter.com/doc/get/friendships/show">GET friendships/show | dev.twitter.com</a>
*/
Relationship showFriendship(String sourceScreenName, String targetScreenName)
throws TwitterException;
/**
- * Gets the detailed relationship status between a source user and a target user
+ * Returns detailed information about the relationship between two users.
* <br>This method calls http://api.twitter.com/1/friendships/show.json
*
* @param sourceId the screen ID of the source user
@@ -151,7 +157,7 @@ Relationship showFriendship(String sourceScreenName, String targetScreenName)
* @return Relationship
* @throws TwitterException when Twitter service or network is unavailable
* @since Twitter4J 2.1.0
- * @see <a href="http://apiwiki.twitter.com/Twitter-REST-API-Method%3A-friendships-show">Twitter API Wiki / Twitter REST API Method: friendships show</a>
+ * @see <a href="http://dev.twitter.com/doc/get/friendships/show">GET friendships/show | dev.twitter.com</a>
*/
Relationship showFriendship(int sourceId, int targetId)
throws TwitterException;
@@ -164,7 +170,7 @@ Relationship showFriendship(int sourceId, int targetId)
* @return an array of numeric IDs for every user who has a pending request to follow the authenticating user.
* @throws TwitterException when Twitter service or network is unavailable
* @since Twitter4J 2.1.2
- * @see <a href="http://apiwiki.twitter.com/Twitter-REST-API-Method%3A-friendships-incoming">Twitter API Wiki / Twitter REST API Method: friendships incoming</a>
+ * @see <a href="http://dev.twitter.com/doc/get/friendships/incoming">GET friendships/incoming | dev.twitter.com</a>
*/
IDs getIncomingFriendships(long cursor) throws TwitterException;
@@ -176,7 +182,7 @@ Relationship showFriendship(int sourceId, int targetId)
* @return an array of numeric IDs for every protected user for whom the authenticating user has a pending follow request.
* @throws TwitterException when Twitter service or network is unavailable
* @since Twitter4J 2.1.2
- * @see <a href="http://apiwiki.twitter.com/Twitter-REST-API-Method%3A-friendships-outgoing">Twitter API Wiki / Twitter REST API Method: friendships outgoing</a>
+ * @see <a href="http://dev.twitter.com/doc/get/friendships/outgoing">GET friendships/outgoing | dev.twitter.com</a>
*/
IDs getOutgoingFriendships(long cursor) throws TwitterException;
}
View
46 twitter4j-core/src/main/java/twitter4j/api/FriendshipMethodsAsync.java
@@ -32,97 +32,103 @@
*/
public interface FriendshipMethodsAsync {
/**
- * Befriends the user specified in the ID parameter as the authenticating user. Returns the befriended user in the requested format when successful.
+ * Allows the authenticating users to follow the user specified in the ID parameter.<br>
+ * Returns the befriended user in the requested format when successful. Returns a string describing the failure condition when unsuccessful. If you are already friends with the user an HTTP 403 will be returned.
* <br>This method calls http://api.twitter.com/1/friendships/create
*
* @param screenName the screen name of the user to be befriended
* @since Twitter4J 2.0.1
- * @see <a href="http://apiwiki.twitter.com/Twitter-REST-API-Method:-friendships%C2%A0create">Twitter API Wiki / Twitter REST API Method: friendships%C2%A0create</a>
+ * @see <a href="http://dev.twitter.com/doc/post/friendships/create/:id">POST friendships/create/:id | dev.twitter.com</a>
*/
void createFriendship(String screenName);
/**
- * Befriends the user specified in the ID parameter as the authenticating user. Returns the befriended user in the requested format when successful.
+ * Allows the authenticating users to follow the user specified in the ID parameter.<br>
+ * Returns the befriended user in the requested format when successful. Returns a string describing the failure condition when unsuccessful. If you are already friends with the user an HTTP 403 will be returned.
* <br>This method calls http://api.twitter.com/1/friendships/create
*
* @param userId the ID of the user to be befriended
* @since Twitter4J 2.1.0
- * @see <a href="http://apiwiki.twitter.com/Twitter-REST-API-Method:-friendships%C2%A0create">Twitter API Wiki / Twitter REST API Method: friendships%C2%A0create</a>
+ * @see <a href="http://dev.twitter.com/doc/post/friendships/create/:id">POST friendships/create/:id | dev.twitter.com</a>
*/
void createFriendship(int userId);
/**
- * Befriends the user specified in the ID parameter as the authenticating user. Returns the befriended user in the requested format when successful.
+ * Allows the authenticating users to follow the user specified in the ID parameter.<br>
+ * Returns the befriended user in the requested format when successful. Returns a string describing the failure condition when unsuccessful. If you are already friends with the user an HTTP 403 will be returned.
* <br>This method calls http://api.twitter.com/1/friendships/create
*
* @param screenName the screen name of the user to be befriended
* @param follow Enable notifications for the target user in addition to becoming friends.
* @since Twitter4J 2.0.1
- * @see <a href="http://apiwiki.twitter.com/Twitter-REST-API-Method:-friendships%C2%A0create">Twitter API Wiki / Twitter REST API Method: friendships%C2%A0create</a>
+ * @see <a href="http://dev.twitter.com/doc/post/friendships/create/:id">POST friendships/create/:id | dev.twitter.com</a>
*/
void createFriendship(String screenName, boolean follow);
/**
- * Befriends the user specified in the ID parameter as the authenticating user. Returns the befriended user in the requested format when successful.
+ * Allows the authenticating users to follow the user specified in the ID parameter.<br>
+ * Returns the befriended user in the requested format when successful. Returns a string describing the failure condition when unsuccessful. If you are already friends with the user an HTTP 403 will be returned.
* <br>This method calls http://api.twitter.com/1/friendships/create
*
* @param userId the ID of the user to be befriended
* @param follow Enable notifications for the target user in addition to becoming friends.
* @since Twitter4J 2.1.0
- * @see <a href="http://apiwiki.twitter.com/Twitter-REST-API-Method:-friendships%C2%A0create">Twitter API Wiki / Twitter REST API Method: friendships%C2%A0create</a>
+ * @see <a href="http://dev.twitter.com/doc/post/friendships/create/:id">POST friendships/create/:id | dev.twitter.com</a>
*/
void createFriendship(int userId, boolean follow);
/**
- * Discontinues friendship with the specified in the ID parameter as the authenticating user. Returns the un-friended user in the requested format when successful.
+ * Allows the authenticating users to unfollow the user specified in the ID parameter.<br>
+ * Returns the unfollowed user in the requested format when successful. Returns a string describing the failure condition when unsuccessful.
* <br>This method calls http://api.twitter.com/1/friendships/destroy
*
* @param screenName the screen name of the user to be befriended
- * @see <a href="http://apiwiki.twitter.com/Twitter-REST-API-Method:-friendships%C2%A0destroy">Twitter API Wiki / Twitter REST API Method: friendships%C2%A0destroy</a>
+ * @see <a href="http://dev.twitter.com/doc/post/friendships/destroy">POST friendships/destroy | dev.twitter.com</a>
* @since Twitter4J 2.0.1
*/
void destroyFriendship(String screenName);
/**
- * Discontinues friendship with the specified in the ID parameter as the authenticating user. Returns the un-friended user in the requested format when successful.
+ * Allows the authenticating users to unfollow the user specified in the ID parameter.<br>
+ * Returns the unfollowed user in the requested format when successful. Returns a string describing the failure condition when unsuccessful.
* <br>This method calls http://api.twitter.com/1/friendships/destroy
*
* @param userId the screen name of the user to be befriended
- * @see <a href="http://apiwiki.twitter.com/Twitter-REST-API-Method:-friendships%C2%A0destroy">Twitter API Wiki / Twitter REST API Method: friendships%C2%A0destroy</a>
+ * @see <a href="http://dev.twitter.com/doc/post/friendships/destroy">POST friendships/destroy | dev.twitter.com</a>
* @since Twitter4J 2.1.0
*/
void destroyFriendship(int userId);
/**
- * Tests if a friendship exists between two users.
+ * Tests for the existence of friendship between two users. Will return true if user_a follows user_b, otherwise will return false.
* <br>This method calls http://api.twitter.com/1/friendships/exists
*
* @param userA The ID or screen_name of the first user to test friendship for.
* @param userB The ID or screen_name of the second user to test friendship for.
* @since Twitter4J 2.0.1
- * @see <a href="http://apiwiki.twitter.com/Twitter-REST-API-Method:-friendships-exists">Twitter API Wiki / Twitter REST API Method: friendships exists</a>
+ * @see <a href="http://dev.twitter.com/doc/get/friendships/exists">GET friendships/exists | dev.twitter.com</a>
*/
void existsFriendship(String userA, String userB);
/**
- * Gets the detailed relationship status between a source user and a target user
+ * Returns detailed information about the relationship between two users.
* <br>This method calls http://api.twitter.com/1/friendships/show.json
*
* @param sourceScreenName the screen name of the source user
* @param targetScreenName the screen name of the target user
* @since Twitter4J 2.1.0
- * @see <a href="http://apiwiki.twitter.com/Twitter-REST-API-Method%3A-friendships-show">Twitter API Wiki / Twitter REST API Method: friendships show</a>
+ * @see <a href="http://dev.twitter.com/doc/get/friendships/show">GET friendships/show | dev.twitter.com</a>
*/
void showFriendship(String sourceScreenName, String targetScreenName);
/**
- * Gets the detailed relationship status between a source user and a target user
+ * Returns detailed information about the relationship between two users.
* <br>This method calls http://api.twitter.com/1/friendships/show.json
*
* @param sourceId the screen ID of the source user
* @param targetId the screen ID of the target user
* @since Twitter4J 2.1.0
- * @see <a href="http://apiwiki.twitter.com/Twitter-REST-API-Method%3A-friendships-show">Twitter API Wiki / Twitter REST API Method: friendships show</a>
+ * @see <a href="http://dev.twitter.com/doc/get/friendships/show">GET friendships/show | dev.twitter.com</a>
*/
void showFriendship(int sourceId, int targetId);
@@ -132,7 +138,7 @@
*
* @param cursor Breaks the results into pages. A single page contains 5000 identifiers. Provide a value of -1 to begin paging.
* @since Twitter4J 2.1.2
- * @see <a href="http://apiwiki.twitter.com/Twitter-REST-API-Method%3A-friendships-incoming">Twitter API Wiki / Twitter REST API Method: friendships incoming</a>
+ * @see <a href="http://dev.twitter.com/doc/get/friendships/incoming">GET friendships/incoming | dev.twitter.com</a>
*/
void getIncomingFriendships(long cursor);
@@ -142,7 +148,7 @@
*
* @param cursor Breaks the results into pages. A single page contains 5000 identifiers. Provide a value of -1 to begin paging.
* @since Twitter4J 2.1.2
- * @see <a href="http://apiwiki.twitter.com/Twitter-REST-API-Method%3A-friendships-outgoing">Twitter API Wiki / Twitter REST API Method: friendships outgoing</a>
+ * @see <a href="http://dev.twitter.com/doc/get/friendships/outgoing">GET friendships/outgoing | dev.twitter.com</a>
*/
void getOutgoingFriendships(long cursor);
}
View
10 twitter4j-core/src/main/java/twitter4j/api/GeoMethods.java
@@ -48,23 +48,25 @@
ResponseList<Place> getNearbyPlaces(GeoQuery query) throws TwitterException;
/**
- * Search for places (cities and neighborhoods) that can be attached to a <a href="http://apiwiki.twitter.com/Twitter-REST-API-Method%3A-statuses%C2%A0update">statuses/update</a>. Given a latitude and a longitude, return a list of all the valid places that can be used as a place_id when updating a status. Conceptually, a query can be made from the user's location, retrieve a list of places, have the user validate the location he or she is at, and then send the ID of this location up with a call to <a href="http://apiwiki.twitter.com/Twitter-REST-API-Method%3A-statuses%C2%A0update">statuses/update</a>.
+ * Search for places (cities and neighborhoods) that can be attached to a statuses/update. Given a latitude and a longitude, return a list of all the valid places that can be used as a place_id when updating a status. Conceptually, a query can be made from the user's location, retrieve a list of places, have the user validate the location he or she is at, and then send the ID of this location up with a call to statuses/update.<br>
+ * There are multiple granularities of places that can be returned -- "neighborhoods", "cities", etc. At this time, only United States data is available through this method.<br>
+ * This API call is meant to be an informative call and will deliver generalized results about geography.
* <br>This method calls http://api.twitter.com/1/geo/reverse_geocode.json
* @param query search query
* @return places (cities and neighborhoods) that can be attached to a statuses/update
* @throws TwitterException when Twitter service or network is unavailable
- * @see <a href="http://apiwiki.twitter.com/Twitter-REST-API-Method%3A-GET-geo-reverse_geocode">Twitter API Wiki / Twitter REST API Method: GET geo reverse_geocode</a>
+ * @see <a href="http://dev.twitter.com/doc/get/geo/reverse_geocode">GET geo/reverse_geocode | dev.twitter.com</a>
* @since Twitter4J 2.1.1
*/
ResponseList<Place> reverseGeoCode(GeoQuery query) throws TwitterException;
/**
- * Find out more details of a place that was returned from the <a href="http://apiwiki.twitter.com/Twitter-REST-API-Method%3A-GET-geo-reverse_geocode">geo/reverse_geocode</a> method.
+ * Find out more details of a place that was returned from the {@link twitter4j.api.GeoMethodsAsync#reverseGeoCode(twitter4j.GeoQuery)} method.
* <br>This method calls http://api.twitter.com/1/geo/id/:id.json
* @param id The ID of the location to query about.
* @return details of the specified place
* @throws TwitterException when Twitter service or network is unavailable
- * @see <a href="http://apiwiki.twitter.com/Twitter-REST-API-Method%3A-GET-geo-ID>Twitter API Wiki / Twitter REST API Method: GET geo ID</a>
+ * @see <a href="http://dev.twitter.com/doc/get/geo/id/:place_id">GET geo/id/:place_id | dev.twitter.com</a>
* @since Twitter4J 2.1.1
*/
Place getGeoDetails(String id) throws TwitterException;
View
BIN  twitter4j-core/src/main/java/twitter4j/api/GeoMethodsAsync.java
Binary file not shown
View
5 twitter4j-core/src/main/java/twitter4j/api/HelpMethods.java
@@ -38,8 +38,7 @@
* @return true if the API is working
* @throws twitter4j.TwitterException when Twitter service or network is unavailable
* @since Twitter4J 1.0.4
- * @see <a href="http://apiwiki.twitter.com/Twitter-REST-API-Method%3A-help%C2%A0test">Twitter API Wiki / Twitter REST API Method: help test</a>
+ * @see <a href="http://dev.twitter.com/doc/get/help/test">GET help/test | dev.twitter.com</a>
*/
- boolean test()
- throws TwitterException;
+ boolean test() throws TwitterException;
}
View
2  twitter4j-core/src/main/java/twitter4j/api/HelpMethodsAsync.java
@@ -35,7 +35,7 @@
* <br>This method calls http://api.twitter.com/1/help/test
*
* @since Twitter4J 2.1.0
- * @see <a href="http://apiwiki.twitter.com/Twitter-REST-API-Method:-help%C2%A0test">Twitter API Wiki / Twitter REST API Method: help%C2%A0test</a>
+ * @see <a href="http://dev.twitter.com/doc/get/help/test">GET help/test | dev.twitter.com</a>
*/
void test();
}
View
19 twitter4j-core/src/main/java/twitter4j/api/ListMembersMethods.java
@@ -43,7 +43,7 @@
* @param cursor Breaks the results into pages. A single page contains 20 lists. Provide a value of -1 to begin paging. Provide values as returned to in the response body's next_cursor and previous_cursor attributes to page back and forth in the list.
* @return the members of the specified list.
* @throws TwitterException when Twitter service or network is unavailable
- * @see <a href="http://apiwiki.twitter.com/Twitter-REST-API-Method%3A-GET-list-members">Twitter REST API Method: GET /:user/:list_id/members</a>
+ * @see <a href="http://dev.twitter.com/doc/get/:user/:list_id/members">GET :user/:list_id/members | dev.twitter.com</a>
* @since Twitter4J 2.1.0
*/
PagableResponseList<User> getUserListMembers(String listOwnerScreenName, int listId, long cursor)
@@ -56,26 +56,25 @@
* @param userId The id of the user to add as a member of the list.
* @return the updated list
* @throws TwitterException when Twitter service or network is unavailable
- * @see <a href="http://apiwiki.twitter.com/Twitter-REST-API-Method%3A-POST-list-members">Twitter REST API Method: POST /:user/:id/members</a>
+ * @see <a href="http://dev.twitter.com/doc/post/:user/:list_id/members">POST :user/:list_id/members | dev.twitter.com</a>
* @since Twitter4J 2.1.0
*/
- UserList addUserListMember(int listId, int userId)
- throws TwitterException;
+ UserList addUserListMember(int listId, int userId) throws TwitterException;
- /**
+ /**
* Removes the specified member from the list. The authenticated user must be the list's owner to remove members from the list.
* <br>This method calls http://api.twitter.com/1/[listOwner]/[listId]/members.json
* @param listId The id of the list.
* @param userId The screen name of the member you wish to remove from the list.
* @return the updated list
* @throws TwitterException when Twitter service or network is unavailable
- * @see <a href="http://apiwiki.twitter.com/Twitter-REST-API-Method%3A-DELETE-list-members">Twitter REST API Method: DELETE /:user/:list_id/members</a>
+ * @see <a href="http://dev.twitter.com/doc/delete/:user/:id/members">DELETE :user/:id/members | dev.twitter.com</a>
* @since Twitter4J 2.1.0
*/
- UserList deleteUserListMember(int listId, int userId)
- throws TwitterException;
+ UserList deleteUserListMember(int listId, int userId)
+ throws TwitterException;
- /**
+ /**
* Check if a user is a member of the specified list.<br>
* <br>This method calls http://api.twitter.com/1/[listOwner]/[listId]/members/id.json
* @param listOwnerScreenName The screen name of the list owner
@@ -84,7 +83,7 @@ UserList deleteUserListMember(int listId, int userId)
* @return the updated list
* @throws TwitterException when Twitter service or network is unavailable
* , or the user is not a member of the specified list(TwitterException.getStatusCode() returns 404 in that case.)
- * @see <a href="http://apiwiki.twitter.com/Twitter-REST-API-Method%3A-GET-list-members-id">Twitter REST API Method: GET /:user/:list_id/members/:id</a>
+ * @see <a href="http://dev.twitter.com/doc/get/:user/:list_id/members/:id">GET :user/:list_id/members/:id | dev.twitter.com</a>
* @since Twitter4J 2.1.0
*/
User checkUserListMembership(String listOwnerScreenName, int listId, int userId)
View
8 twitter4j-core/src/main/java/twitter4j/api/ListMembersMethodsAsync.java
@@ -36,7 +36,7 @@
* @param listOwnerScreenName The screen name of the list owner
* @param listId The id of the list
* @param cursor Breaks the results into pages. A single page contains 20 lists. Provide a value of -1 to begin paging. Provide values as returned to in the response body's next_cursor and previous_cursor attributes to page back and forth in the list.
- * @see <a href="http://apiwiki.twitter.com/Twitter-REST-API-Method%3A-GET-list-members">Twitter REST API Method: GET /:user/:list_id/members</a>
+ * @see <a href="http://dev.twitter.com/doc/get/:user/:list_id/members">GET :user/:list_id/members | dev.twitter.com</a>
* @since Twitter4J 2.1.1
*/
void getUserListMembers(String listOwnerScreenName, int listId, long cursor);
@@ -46,7 +46,7 @@
* <br>This method calls http://api.twitter.com/1/[listOwner]/[listId]/members.json
* @param listId The id of the list.
* @param userId The id of the user to add as a member of the list.
- * @see <a href="http://apiwiki.twitter.com/Twitter-REST-API-Method%3A-POST-list-members">Twitter REST API Method: POST /:user/:id/members</a>
+ * @see <a href="http://dev.twitter.com/doc/post/:user/:list_id/members">POST :user/:list_id/members | dev.twitter.com</a>
* @since Twitter4J 2.1.1
*/
void addUserListMember(int listId, int userId);
@@ -56,7 +56,7 @@
* <br>This method calls http://api.twitter.com/1/[listOwner]/[listId]/members.json
* @param listId The id of the list.
* @param userId The screen name of the member you wish to remove from the list.
- * @see <a href="http://apiwiki.twitter.com/Twitter-REST-API-Method%3A-DELETE-list-members">Twitter REST API Method: DELETE /:user/:list_id/members</a>
+ * @see <a href="http://dev.twitter.com/doc/delete/:user/:id/members">DELETE :user/:id/members | dev.twitter.com</a>
* @since Twitter4J 2.1.0
*/
void deleteUserListMember(int listId, int userId);
@@ -67,7 +67,7 @@
* @param listOwnerScreenName The screen name of the list owner
* @param listId The id of the list.
* @param userId The id of the user who you want to know is a member or not of the specified list.
- * @see <a href="http://apiwiki.twitter.com/Twitter-REST-API-Method%3A-GET-list-members-id">Twitter REST API Method: GET /:user/:list_id/members/:id</a>
+ * @see <a href="http://dev.twitter.com/doc/get/:user/:list_id/members/:id">GET :user/:list_id/members/:id | dev.twitter.com</a>
* @since Twitter4J 2.1.0
*/
void checkUserListMembership(String listOwnerScreenName, int listId, int userId);
View
31 twitter4j-core/src/main/java/twitter4j/api/ListMethods.java
@@ -38,7 +38,7 @@
*/
public interface ListMethods {
/**
- * Creates a new list for the authenticated user.
+ * Creates a new list for the authenticated user. Accounts are limited to 20 lists.
* <br>This method calls http://api.twitter.com/1/user/lists.json
*
* @param listName The name of the list you are creating. Required.
@@ -46,7 +46,7 @@
* @param description The description of the list you are creating. Optional.
* @return the list that was created
* @throws twitter4j.TwitterException when Twitter service or network is unavailable, or the authenticated user already has 20 lists(TwitterException.getStatusCode() == 403).
- * @see <a href="http://apiwiki.twitter.com/Twitter-REST-API-Method%3A-POST-lists">Twitter REST API Method: POST lists</a>
+ * @see <a href="http://dev.twitter.com/doc/post/:user/lists">POST :user/lists | dev.twitter.com</a>
* @since Twitter4J 2.1.0
*/
UserList createUserList(String listName, boolean isPublicList, String description)
@@ -54,7 +54,7 @@ UserList createUserList(String listName, boolean isPublicList, String descriptio
/**
* Updates the specified list.
- * <br>This method calls http://api.twitter.com/1/user/lists/id.json
+ * <br>This method calls http://api.twitter.com/1/:user/lists/:id.json
*
* @param listId The id of the list to update.
* @param newListName What you'd like to change the list's name to.
@@ -62,7 +62,7 @@ UserList createUserList(String listName, boolean isPublicList, String descriptio
* @param newDescription What you'd like to change the list description to.
* @return the updated list
* @throws TwitterException when Twitter service or network is unavailable
- * @see <a href="http://apiwiki.twitter.com/Twitter-REST-API-Method%3A-POST-lists-id">Twitter REST API Method: POST lists id</a>
+ * @see <a href="http://dev.twitter.com/doc/post/:user/lists/:id">POST :user/lists/:id | dev.twitter.com</a>
* @since Twitter4J 2.1.0
*/
UserList updateUserList(int listId, String newListName, boolean isPublicList, String newDescription)
@@ -70,13 +70,13 @@ UserList updateUserList(int listId, String newListName, boolean isPublicList, St
/**
* List the lists of the specified user. Private lists will be included if the authenticated users is the same as the user whose lists are being returned.
- * <br>This method calls http://api.twitter.com/1/user/lists.json
+ * <br>This method calls http://api.twitter.com/1/:user/lists.json
*
* @param listOwnerScreenName The screen name of the list owner
* @param cursor Breaks the results into pages. A single page contains 20 lists. Provide a value of -1 to begin paging. Provide values as returned to in the response body's next_cursor and previous_cursor attributes to page back and forth in the list.
* @return the list of lists
* @throws TwitterException when Twitter service or network is unavailable
- * @see <a href="http://apiwiki.twitter.com/Twitter-REST-API-Method%3A-GET-lists">Twitter REST API Method: GET lists</a>
+ * @see <a href="http://dev.twitter.com/doc/get/:user/lists">GET :user/lists | dev.twitter.com</a>
* @since Twitter4J 2.1.0
*/
PagableResponseList<UserList> getUserLists(String listOwnerScreenName, long cursor)
@@ -84,13 +84,13 @@ UserList updateUserList(int listId, String newListName, boolean isPublicList, St
/**
* Show the specified list. Private lists will only be shown if the authenticated user owns the specified list.
- * <br>This method calls http://api.twitter.com/1/user/lists/id.json
+ * <br>This method calls http://api.twitter.com/1/:user/lists/:id.json
*
* @param listOwnerScreenName The screen name of the list owner
* @param id The id of the list to show
* @return the specified list
* @throws TwitterException when Twitter service or network is unavailable
- * @see <a href="http://apiwiki.twitter.com/Twitter-REST-API-Method%3A-GET-list-id">Twitter REST API Method: GET list id</a>
+ * @see <a href="http://dev.twitter.com/doc/get/:user/lists/:id">GET :user/lists/:id | dev.twitter.com</a>
* @since Twitter4J 2.1.0
*/
UserList showUserList(String listOwnerScreenName, int id)
@@ -98,16 +98,15 @@ UserList showUserList(String listOwnerScreenName, int id)
/**
* Deletes the specified list. Must be owned by the authenticated user.
- * <br>This method calls http://api.twitter.com/1/[user]/lists/[id].json
+ * <br>This method calls http://api.twitter.com/1/:user/lists/:id.json
*
* @param listId The id of the list to delete
* @return the deleted list
* @throws TwitterException when Twitter service or network is unavailable
- * @see <a href="http://apiwiki.twitter.com/Twitter-REST-API-Method%3A-DELETE-list-id">Twitter REST API Method: DELETE /:user/lists/:id</a>
+ * @see <a href="http://dev.twitter.com/doc/delete/:user/lists/:id">DELETE :user/lists/:id | dev.twitter.com</a>
* @since Twitter4J 2.1.0
*/
- UserList destroyUserList(int listId)
- throws TwitterException;
+ UserList destroyUserList(int listId) throws TwitterException;
/**
* Show tweet timeline for members of the specified list.
@@ -118,7 +117,7 @@ UserList destroyUserList(int listId)
* @param paging controls pagination. Supports since_id, max_id, count and page parameters.
* @return list of statuses for members of the specified list
* @throws TwitterException when Twitter service or network is unavailable
- * @see <a href="http://apiwiki.twitter.com/Twitter-REST-API-Method%3A-GET-list-statuses">Twitter REST API Method: GET list statuses</a>
+ * @see <a href="http://dev.twitter.com/doc/get/:user/lists/:id/statuses">GET :user/lists/:id/statuses | dev.twitter.com</a>
* @since Twitter4J 2.1.0
*/
ResponseList<Status> getUserListStatuses(String listOwnerScreenName, int id, Paging paging)
@@ -126,13 +125,13 @@ UserList destroyUserList(int listId)
/**
* List the lists the specified user has been added to.
- * <br>This method calls http://api.twitter.com/1/user/lists/memberships.json
+ * <br>This method calls http://api.twitter.com/1/:user/lists/memberships.json
*
* @param listOwnerScreenName The screen name of the list owner
* @param cursor Breaks the results into pages. A single page contains 20 lists. Provide a value of -1 to begin paging. Provide values as returned to in the response body's next_cursor and previous_cursor attributes to page back and forth in the list.
* @return the list of lists
* @throws TwitterException when Twitter service or network is unavailable
- * @see <a href="http://apiwiki.twitter.com/Twitter-REST-API-Method%3A-GET-list-memberships">Twitter REST API Method: GET /:user/lists/memberships</a>
+ * @see <a href="http://dev.twitter.com/doc/get/:user/lists/memberships">GET :user/lists/memberships | dev.twitter.com</a>
* @since Twitter4J 2.1.0
*/
PagableResponseList<UserList> getUserListMemberships(String listOwnerScreenName, long cursor)
@@ -146,7 +145,7 @@ UserList destroyUserList(int listId)
* @param cursor Breaks the results into pages. A single page contains 20 lists. Provide a value of -1 to begin paging. Provide values as returned to in the response body's next_cursor and previous_cursor attributes to page back and forth in the list.
* @return the list of lists
* @throws TwitterException when Twitter service or network is unavailable
- * @see <a href="http://apiwiki.twitter.com/Twitter-REST-API-Method%3A-GET-list-subscriptions">Twitter REST API Method: GET list subscriptions</a>
+ * @see <a href="http://dev.twitter.com/doc/get/:user/lists/subscriptions">GET :user/lists/subscriptions | dev.twitter.com</a>
* @since Twitter4J 2.1.0
*/
PagableResponseList<UserList> getUserListSubscriptions(String listOwnerScreenName, long cursor)
View
28 twitter4j-core/src/main/java/twitter4j/api/ListMethodsAsync.java
@@ -33,58 +33,58 @@
*/
public interface ListMethodsAsync {
/**
- * Creates a new list for the authenticated user.
+ * Creates a new list for the authenticated user. Accounts are limited to 20 lists.
* <br>This method calls http://api.twitter.com/1/user/lists.json
*
* @param listName The name of the list you are creating. Required.
* @param isPublicList set true if you wish to make a public list
* @param description The description of the list you are creating. Optional.
- * @see <a href="http://apiwiki.twitter.com/Twitter-REST-API-Method%3A-POST-lists">Twitter REST API Method: POST lists</a>
+ * @see <a href="http://dev.twitter.com/doc/post/:user/lists">POST :user/lists | dev.twitter.com</a>
* @since Twitter4J 2.1.1
*/
void createUserList(String listName, boolean isPublicList, String description);
/**
* Updates the specified list.
- * <br>This method calls http://api.twitter.com/1/user/lists/id.json
+ * <br>This method calls http://api.twitter.com/1/:user/lists/:id.json
*
* @param listId The id of the list to update.
* @param newListName What you'd like to change the list's name to.
* @param isPublicList Whether your list is public or private. Optional. Values can be public or private. Lists are public by default if no mode is specified.
* @param newDescription What you'd like to change the list description to.
- * @see <a href="http://apiwiki.twitter.com/Twitter-REST-API-Method%3A-POST-lists-id">Twitter REST API Method: POST lists id</a>
+ * @see <a href="http://dev.twitter.com/doc/post/:user/lists/:id">POST :user/lists/:id | dev.twitter.com</a>
* @since Twitter4J 2.1.1
*/
void updateUserList(int listId, String newListName, boolean isPublicList, String newDescription);
/**
* List the lists of the specified user. Private lists will be included if the authenticated users is the same as the user whose lists are being returned.
- * <br>This method calls http://api.twitter.com/1/user/lists.json
+ * <br>This method calls http://api.twitter.com/1/:user/lists.json
*
* @param listOwnerScreenName The screen name of the list owner
* @param cursor Breaks the results into pages. A single page contains 20 lists. Provide a value of -1 to begin paging. Provide values as returned to in the response body's next_cursor and previous_cursor attributes to page back and forth in the list.
- * @see <a href="http://apiwiki.twitter.com/Twitter-REST-API-Method%3A-GET-lists">Twitter REST API Method: GET lists</a>
+ * @see <a href="http://dev.twitter.com/doc/get/:user/lists">GET :user/lists | dev.twitter.com</a>
* @since Twitter4J 2.1.1
*/
void getUserLists(String listOwnerScreenName, long cursor);
/**
* Show the specified list. Private lists will only be shown if the authenticated user owns the specified list.
- * <br>This method calls http://api.twitter.com/1/user/lists/id.json
+ * <br>This method calls http://api.twitter.com/1/:user/lists/:id.json
*
* @param listOwnerScreenName The screen name of the list owner
* @param id The id of the list to show
- * @see <a href="http://apiwiki.twitter.com/Twitter-REST-API-Method%3A-GET-list-id">Twitter REST API Method: GET list id</a>
+ * @see <a href="http://dev.twitter.com/doc/get/:user/lists/:id">GET :user/lists/:id | dev.twitter.com</a>
* @since Twitter4J 2.1.1
*/
void showUserList(String listOwnerScreenName, int id);
/**
* Deletes the specified list. Must be owned by the authenticated user.
- * <br>This method calls http://api.twitter.com/1/[user]/lists/[id].json
+ * <br>This method calls http://api.twitter.com/1/:user/lists/:id.json
*
* @param listId The id of the list to delete
- * @see <a href="http://apiwiki.twitter.com/Twitter-REST-API-Method%3A-DELETE-list-id">Twitter REST API Method: DELETE /:user/lists/:id</a>
+ * @see <a href="http://dev.twitter.com/doc/delete/:user/lists/:id">DELETE :user/lists/:id | dev.twitter.com</a>
* @since Twitter4J 2.1.1
*/
void destroyUserList(int listId);
@@ -96,18 +96,18 @@
* @param listOwnerScreenName The screen name of the list owner
* @param id The id of the list to delete
* @param paging controls pagination. Supports since_id, max_id, count and page parameters.
- * @see <a href="http://apiwiki.twitter.com/Twitter-REST-API-Method%3A-GET-list-statuses">Twitter REST API Method: GET list statuses</a>
+ * @see <a href="http://dev.twitter.com/doc/get/:user/lists/:id/statuses">GET :user/lists/:id/statuses | dev.twitter.com</a>
* @since Twitter4J 2.1.1
*/
void getUserListStatuses(String listOwnerScreenName, int id, Paging paging);
/**
* List the lists the specified user has been added to.
- * <br>This method calls http://api.twitter.com/1/user/lists/memberships.json
+ * <br>This method calls http://api.twitter.com/1/:user/lists/memberships.json
*
* @param listOwnerScreenName The screen name of the list owner
* @param cursor Breaks the results into pages. A single page contains 20 lists. Provide a value of -1 to begin paging. Provide values as returned to in the response body's next_cursor and previous_cursor attributes to page back and forth in the list.
- * @see <a href="http://apiwiki.twitter.com/Twitter-REST-API-Method%3A-GET-list-memberships">Twitter REST API Method: GET /:user/lists/memberships</a>
+ * @see <a href="http://dev.twitter.com/doc/get/:user/lists/memberships">GET :user/lists/memberships | dev.twitter.com</a>
* @since Twitter4J 2.1.1
*/
void getUserListMemberships(String listOwnerScreenName, long cursor);
@@ -118,7 +118,7 @@
*
* @param listOwnerScreenName The screen name of the list owner
* @param cursor Breaks the results into pages. A single page contains 20 lists. Provide a value of -1 to begin paging. Provide values as returned to in the response body's next_cursor and previous_cursor attributes to page back and forth in the list.
- * @see <a href="http://apiwiki.twitter.com/Twitter-REST-API-Method%3A-GET-list-subscriptions">Twitter REST API Method: GET list subscriptions</a>
+ * @see <a href="http://dev.twitter.com/doc/get/:user/lists/subscriptions">GET :user/lists/subscriptions | dev.twitter.com</a>
* @since Twitter4J 2.1.1
*/
void getUserListSubscriptions(String listOwnerScreenName, long cursor);
View
16 twitter4j-core/src/main/java/twitter4j/api/ListSubscribersMethods.java
@@ -37,13 +37,13 @@
public interface ListSubscribersMethods {
/**
* Returns the subscribers of the specified list.
- * <br>This method calls http://api.twitter.com/1/[user]/[list_id]/subscribers.json
+ * <br>This method calls http://api.twitter.com/1/:user/:list_id/subscribers.json
* @param listOwnerScreenName The screen name of the list owner
* @param listId The id of the list
* @param cursor Breaks the results into pages. A single page contains 20 lists. Provide a value of -1 to begin paging. Provide values as returned to in the response body's next_cursor and previous_cursor attributes to page back and forth in the list.
* @return the members of the specified list.
* @throws twitter4j.TwitterException when Twitter service or network is unavailable
- * @see <a href="http://apiwiki.twitter.com/Twitter-REST-API-Method%3A-GET-list-subscribers">Twitter REST API Method: GET /:user/:list_id/members</a>
+ * @see <a href="http://dev.twitter.com/doc/get/:user/:list_id/subscribers">GET :user/:list_id/subscribers | dev.twitter.com</a>
* @since Twitter4J 2.1.0
*/
PagableResponseList<User> getUserListSubscribers(String listOwnerScreenName, int listId, long cursor)
@@ -51,12 +51,12 @@
/**
* Make the authenticated user follow the specified list.
- * <br>This method calls http://api.twitter.com/1/[listOwner]/[listId]/subscribers.json
+ * <br>This method calls http://api.twitter.com/1/:listOwner/:listId/subscribers.json
* @param listOwnerScreenName The screen name of the list owner
* @param listId The id of the list.
* @return the updated list
* @throws TwitterException when Twitter service or network is unavailable
- * @see <a href="http://apiwiki.twitter.com/Twitter-REST-API-Method%3A-POST-list-subscribers">Twitter REST API Method: POST /:user/:id/members</a>
+ * @see <a href="http://dev.twitter.com/doc/post/:user/:list_id/subscribers">POST :user/:list_id/subscribers | dev.twitter.com</a>
* @since Twitter4J 2.1.0
*/
UserList subscribeUserList(String listOwnerScreenName, int listId)
@@ -64,12 +64,12 @@ UserList subscribeUserList(String listOwnerScreenName, int listId)
/**
* Unsubscribes the authenticated user form the specified list.
- * <br>This method calls http://api.twitter.com/1/[listOwner]/[listId]/subscribers.json
+ * <br>This method calls http://api.twitter.com/1/:listOwner/:listId/subscribers.json
* @param listOwnerScreenName The screen name of the list owner
* @param listId The id of the list.
* @return the updated list
* @throws TwitterException when Twitter service or network is unavailable
- * @see <a href="http://apiwiki.twitter.com/Twitter-REST-API-Method%3A-DELETE-list-subscribers">Twitter REST API Method: DELETE /:user/:list_id/members</a>
+ * @see <a href="http://dev.twitter.com/doc/delete/:user/:id/subscribers">DELETE :user/:id/subscribers | dev.twitter.com</a>
* @since Twitter4J 2.1.0
*/
UserList unsubscribeUserList(String listOwnerScreenName, int listId)
@@ -77,14 +77,14 @@ UserList unsubscribeUserList(String listOwnerScreenName, int listId)
/**
* Check if the specified user is a subscriber of the specified list.
- * <br>This method calls http://api.twitter.com/1/[listOwner]/[listId]/subscribers/[userId].json
+ * <br>This method calls http://api.twitter.com/1/:listOwner/:listId/subscribers/:userId.json
* @param listOwnerScreenName The screen name of the list owner
* @param listId The id of the list.
* @param userId The id of the user who you want to know is a member or not of the specified list.
* @return the updated list
* @throws TwitterException when Twitter service or network is unavailable
* , or the user is not a member of the specified list(TwitterException.getStatusCode() returns 404 in that case.)
- * @see <a href="http://apiwiki.twitter.com/Twitter-REST-API-Method%3A-GET-list-subscribers-id">Twitter REST API Method: GET /:user/:list_id/subscribers/:id</a>
+ * @see <a href="http://dev.twitter.com/doc/get/:user/:list_id/subscribers/:id">GET :user/:list_id/subscribers/:id | dev.twitter.com</a>
* @since Twitter4J 2.1.0
*/
User checkUserListSubscription(String listOwnerScreenName, int listId, int userId)
View
16 twitter4j-core/src/main/java/twitter4j/api/ListSubscribersMethodsAsync.java
@@ -33,43 +33,43 @@
public interface ListSubscribersMethodsAsync {
/**
* Returns the subscribers of the specified list.
- * <br>This method calls http://api.twitter.com/1/[user]/[list_id]/subscribers.json
+ * <br>This method calls http://api.twitter.com/1/:user/:list_id/subscribers.json
* @param listOwnerScreenName The screen name of the list owner
* @param listId The id of the list
* @param cursor Breaks the results into pages. A single page contains 20 lists. Provide a value of -1 to begin paging. Provide values as returned to in the response body's next_cursor and previous_cursor attributes to page back and forth in the list.
- * @see <a href="http://apiwiki.twitter.com/Twitter-REST-API-Method%3A-GET-list-subscribers">Twitter REST API Method: GET /:user/:list_id/members</a>
+ * @see <a href="http://dev.twitter.com/doc/get/:user/:list_id/subscribers">GET :user/:list_id/subscribers | dev.twitter.com</a>
* @since Twitter4J 2.1.1
*/
void getUserListSubscribers(String listOwnerScreenName, int listId, long cursor);
/**
* Make the authenticated user follow the specified list.
- * <br>This method calls http://api.twitter.com/1/[listOwner]/[listId]/subscribers.json
+ * <br>This method calls http://api.twitter.com/1/:listOwner/:listId/subscribers.json
* @param listOwnerScreenName The screen name of the list owner
* @param listId The id of the list.
- * @see <a href="http://apiwiki.twitter.com/Twitter-REST-API-Method%3A-POST-list-subscribers">Twitter REST API Method: POST /:user/:id/members</a>
+ * @see <a href="http://dev.twitter.com/doc/post/:user/:list_id/subscribers">POST :user/:list_id/subscribers | dev.twitter.com</a>
* @since Twitter4J 2.1.1
*/
void subscribeUserList(String listOwnerScreenName, int listId);
/**
* Unsubscribes the authenticated user form the specified list.
- * <br>This method calls http://api.twitter.com/1/[listOwner]/[listId]/subscribers.json
+ * <br>This method calls http://api.twitter.com/1/:listOwner/:listId/subscribers.json
* @param listOwnerScreenName The screen name of the list owner
* @param listId The id of the list.
- * @see <a href="http://apiwiki.twitter.com/Twitter-REST-API-Method%3A-DELETE-list-subscribers">Twitter REST API Method: DELETE /:user/:list_id/members</a>
+ * @see <a href="http://dev.twitter.com/doc/delete/:user/:id/subscribers">DELETE :user/:id/subscribers | dev.twitter.com</a>
* @since Twitter4J 2.1.1
*/
void unsubscribeUserList(String listOwnerScreenName, int listId);
/**
* Check if the specified user is a subscriber of the specified list.
- * <br>This method calls http://api.twitter.com/1/[listOwner]/[listId]/subscribers/[userId].json
+ * <br>This method calls http://api.twitter.com/1/:listOwner/:listId/subscribers/:userId.json
* @param listOwnerScreenName The screen name of the list owner
* @param listId The id of the list.
* @param userId The id of the user who you want to know is a member or not of the specified list.
* , or the user is not a member of the specified list(TwitterException.getStatusCode() returns 404 in that case.)
- * @see <a href="http://apiwiki.twitter.com/Twitter-REST-API-Method%3A-GET-list-subscribers-id">Twitter REST API Method: GET /:user/:list_id/subscribers/:id</a>
+ * @see <a href="http://dev.twitter.com/doc/get/:user/:list_id/subscribers/:id">GET :user/:list_id/subscribers/:id | dev.twitter.com</a>
* @since Twitter4J 2.1.1
*/
void checkUserListSubscription(String listOwnerScreenName, int listId, int userId);
View
8 twitter4j-core/src/main/java/twitter4j/api/LocalTrendsMethods.java
@@ -41,7 +41,7 @@
* <br>This method calls http://api.twitter.com/1/trends/available.json
* @return the locations
* @throws twitter4j.TwitterException when Twitter service or network is unavailable
- * @see <a href="http://apiwiki.twitter.com/Twitter-REST-API-Method%3A-trends-available">Twitter REST API Method: GET /:user/:list_id/members</a>
+ * @see <a href="http://dev.twitter.com/doc/get/trends/available">GET trends/available | dev.twitter.com</a>
* @since Twitter4J 2.1.1
*/
ResponseList<Location> getAvailableTrends() throws TwitterException;
@@ -52,18 +52,18 @@
* @param location the available trend locations will be sorted by distance to the lat and long passed in. The sort is nearest to furthest.
* @return the locations
* @throws twitter4j.TwitterException when Twitter service or network is unavailable
- * @see <a href="http://apiwiki.twitter.com/Twitter-REST-API-Method%3A-trends-available">Twitter REST API Method: GET /:user/:list_id/members</a>
+ * @see <a href="http://dev.twitter.com/doc/get/trends/available">GET trends/available | dev.twitter.com</a>
* @since Twitter4J 2.1.1
*/
ResponseList<Location> getAvailableTrends(GeoLocation location) throws TwitterException;
/**
* Returns the top 10 trending topics for a specific location Twitter has trending topic information for. The response is an array of "trend" objects that encode the name of the trending topic, the query parameter that can be used to search for the topic on Search, and the direct URL that can be issued against Search. This information is cached for five minutes, and therefore users are discouraged from querying these endpoints faster than once every five minutes. Global trends information is also available from this API by using a WOEID of 1.
- * <br>This method calls http://api.twitter.com/1/trends/[woeid].json
+ * <br>This method calls http://api.twitter.com/1/trends/:woeid.json
* @param woeid The WOEID of the location to be querying for
* @return trends
* @throws twitter4j.TwitterException when Twitter service or network is unavailable
- * @see <a href="http://apiwiki.twitter.com/Twitter-REST-API-Method%3A-trends-location">Twitter REST API Method: trends location</a>
+ * @see <a href="http://dev.twitter.com/doc/get/trends/location/:woeid">GET trends/location/:woeid | dev.twitter.com</a>
* @since Twitter4J 2.1.1
*/
Trends getLocationTrends(int woeid) throws TwitterException;
View
8 twitter4j-core/src/main/java/twitter4j/api/LocalTrendsMethodsAsync.java
@@ -35,7 +35,7 @@
/**
* Retrieves the locations that Twitter has trending topic information for. The response is an array of &quot;locations&quot; that encode the location's WOEID (a <a href="http://developer.yahoo.com/geo/geoplanet/">Yahoo! Where On Earth ID</a>) and some other human-readable information such as a canonical name and country the location belongs in.
* <br>This method calls http://api.twitter.com/1/trends/available.json
- * @see <a href="http://apiwiki.twitter.com/Twitter-REST-API-Method%3A-trends-available">Twitter REST API Method: GET /:user/:list_id/members</a>
+ * @see <a href="http://dev.twitter.com/doc/get/trends/available">GET trends/available | dev.twitter.com</a>
* @since Twitter4J 2.1.1
*/
void getAvailableTrends();
@@ -44,16 +44,16 @@
* Retrieves the sorted locations that Twitter has trending topic information for. The response is an array of &quot;locations&quot; that encode the location's WOEID (a <a href="http://developer.yahoo.com/geo/geoplanet/">Yahoo! Where On Earth ID</a>) and some other human-readable information such as a canonical name and country the location belongs in.
* <br>This method calls http://api.twitter.com/1/trends/available.json
* @param location the available trend locations will be sorted by distance to the lat and long passed in. The sort is nearest to furthest.
- * @see <a href="http://apiwiki.twitter.com/Twitter-REST-API-Method%3A-trends-available">Twitter REST API Method: GET /:user/:list_id/members</a>
+ * @see <a href="http://dev.twitter.com/doc/get/trends/available">GET trends/available | dev.twitter.com</a>
* @since Twitter4J 2.1.1
*/
void getAvailableTrends(GeoLocation location);
/**
* Retrieves the top 10 trending topics for a specific location Twitter has trending topic information for. The response is an array of "trend" objects that encode the name of the trending topic, the query parameter that can be used to search for the topic on Search, and the direct URL that can be issued against Search. This information is cached for five minutes, and therefore users are discouraged from querying these endpoints faster than once every five minutes. Global trends information is also available from this API by using a WOEID of 1.
- * <br>This method calls http://api.twitter.com/1/trends/[woeid].json
+ * <br>This method calls http://api.twitter.com/1/trends/:woeid.json
* @param woeid The WOEID of the location to be querying for
- * @see <a href="http://apiwiki.twitter.com/Twitter-REST-API-Method%3A-trends-location">Twitter REST API Method: trends location</a>
+ * @see <a href="http://dev.twitter.com/doc/get/trends/location/:woeid">GET trends/location/:woeid | dev.twitter.com</a>
* @since Twitter4J 2.1.1
*/
void getLocationTrends(int woeid);
View
16 twitter4j-core/src/main/java/twitter4j/api/NotificationMethods.java
@@ -35,52 +35,52 @@
public interface NotificationMethods {
/**
* Enables notifications for updates from the specified user to the authenticating user. Returns the specified user when successful.
- * <br>This method calls http://api.twitter.com/1/notifications/follow/[id].json
+ * <br>This method calls http://api.twitter.com/1/notifications/follow.json
*
* @param screenName Specifies the screen name of the user to follow with device updates.
* @return User
* @throws TwitterException when Twitter service or network is unavailable
* @since Twitter4J 2.0.1
- * @see <a href="http://apiwiki.twitter.com/Twitter-REST-API-Method%3A-notifications%C2%A0follow">Twitter API Wiki / Twitter REST API Method: notifications follow</a>
+ * @see <a href="http://dev.twitter.com/doc/post/notifications/follow">POST notifications/follow | dev.twitter.com</a>
*/
User enableNotification(String screenName)
throws TwitterException;
/**
* Enables notifications for updates from the specified user to the authenticating user. Returns the specified user when successful.
- * <br>This method calls http://api.twitter.com/1/notifications/follow/[id].json
+ * <br>This method calls http://api.twitter.com/1/notifications/follow.json
*
* @param userId Specifies the ID of the user to follow with device updates.
* @return User
* @throws TwitterException when Twitter service or network is unavailable
* @since Twitter4J 2.1.0
- * @see <a href="http://apiwiki.twitter.com/Twitter-REST-API-Method%3A-notifications%C2%A0follow">Twitter API Wiki / Twitter REST API Method: notifications follow</a>
+ * @see <a href="http://dev.twitter.com/doc/post/notifications/follow">POST notifications/follow | dev.twitter.com</a>
*/
User enableNotification(int userId)
throws TwitterException;
/**
* Disables notifications for updates from the specified user to the authenticating user. Returns the specified user when successful.
- * <br>This method calls http://api.twitter.com/1/notifications/leave/[id].json
+ * <br>This method calls http://api.twitter.com/1/notifications/leave.json
*
* @param screenName Specifies the screen name of the user to disable device notifications.
* @return User
* @throws TwitterException when Twitter service or network is unavailable
* @since Twitter4J 2.0.1
- * @see <a href="http://apiwiki.twitter.com/Twitter-REST-API-Method%3A-notifications%C2%A0leave">Twitter API Wiki / Twitter REST API Method: notifications leave</a>
+ * @see <a href="http://dev.twitter.com/doc/post/notifications/leave">POST notifications/leave | dev.twitter.com</a>
*/
User disableNotification(String screenName)
throws TwitterException;
/**
* Disables notifications for updates from the specified user to the authenticating user. Returns the specified user when successful.
- * <br>This method calls http://api.twitter.com/1/notifications/leave/[id].json
+ * <br>This method calls http://api.twitter.com/1/notifications/leave.json
*
* @param userId Specifies the ID of the user to disable device notifications.
* @return User
* @throws TwitterException when Twitter service or network is unavailable
* @since Twitter4J 2.1.0
- * @see <a href="http://apiwiki.twitter.com/Twitter-REST-API-Method%3A-notifications%C2%A0leave">Twitter API Wiki / Twitter REST API Method: notifications leave</a>
+ * @see <a href="http://dev.twitter.com/doc/post/notifications/leave">POST notifications/leave | dev.twitter.com</a>
*/
User disableNotification(int userId)
throws TwitterException;
View
16 twitter4j-core/src/main/java/twitter4j/api/NotificationMethodsAsync.java
@@ -32,41 +32,41 @@
public interface NotificationMethodsAsync {
/**
* Enables notifications for updates from the specified user to the authenticating user. Returns the specified user when successful.
- * <br>This method calls http://api.twitter.com/1/notifications/follow
+ * <br>This method calls http://api.twitter.com/1/notifications/follow.json
*
* @param screenName Specifies the screen name of the user to follow with device updates.
* @since Twitter4J 2.0.1
- * @see <a href="http://apiwiki.twitter.com/Twitter-REST-API-Method:-notifications%C2%A0follow">Twitter API Wiki / Twitter REST API Method: notifications%C2%A0follow</a>
+ * @see <a href="http://dev.twitter.com/doc/post/notifications/follow">POST notifications/follow | dev.twitter.com</a>
*/
void enableNotification(String screenName);
/**
* Enables notifications for updates from the specified user to the authenticating user. Returns the specified user when successful.
- * <br>This method calls http://api.twitter.com/1/notifications/follow
+ * <br>This method calls http://api.twitter.com/1/notifications/follow.json
*
* @param userId Specifies the ID of the user to follow with device updates.
* @since Twitter4J 2.1.0
- * @see <a href="http://apiwiki.twitter.com/Twitter-REST-API-Method:-notifications%C2%A0follow">Twitter API Wiki / Twitter REST API Method: notifications%C2%A0follow</a>
+ * @see <a href="http://dev.twitter.com/doc/post/notifications/follow">POST notifications/follow | dev.twitter.com</a>
*/
void enableNotification(int userId);
/**
* Disables notifications for updates from the specified user to the authenticating user. Returns the specified user when successful.
- * <br>This method calls http://api.twitter.com/1/notifications/leave
+ * <br>This method calls http://api.twitter.com/1/notifications/leave.json
*
* @param screenName Specifies the screen name of the user to disable device notifications.
* @since Twitter4J 2.0.1
- * @see <a href="http://apiwiki.twitter.com/Twitter-REST-API-Method:-notifications%C2%A0leave">Twitter API Wiki / Twitter REST API Method: notifications%C2%A0leave</a>
+ * @see <a href="http://dev.twitter.com/doc/post/notifications/leave">POST notifications/leave | dev.twitter.com</a>
*/
void disableNotification(String screenName);
/**
* Disables notifications for updates from the specified user to the authenticating user. Returns the specified user when successful.
- * <br>This method calls http://api.twitter.com/1/notifications/leave
+ * <br>This method calls http://api.twitter.com/1/notifications/leave.json
*
* @param userId Specifies the ID of the user to disable device notifications.
* @since Twitter4J 2.1.0
- * @see <a href="http://apiwiki.twitter.com/Twitter-REST-API-Method:-notifications%C2%A0leave">Twitter API Wiki / Twitter REST API Method: notifications%C2%A0leave</a>
+ * @see <a href="http://dev.twitter.com/doc/post/notifications/leave">POST notifications/leave | dev.twitter.com</a>
*/
void disableNotification(int userId);
}
View
22 twitter4j-core/src/main/java/twitter4j/api/SavedSearchesMethods.java
@@ -42,31 +42,29 @@
* @return Returns an array of numeric user ids the authenticating user is blocking.
* @throws TwitterException when Twitter service or network is unavailable
* @since Twitter4J 2.0.8
- * @see <a href="http://apiwiki.twitter.com/Twitter-REST-API-Method%3A-saved_searches">Twitter API Wiki / Twitter REST API Method: saved_searches</a>
+ * @see <a href="http://dev.twitter.com/doc/get/saved_searches">GET saved_searches | dev.twitter.com</a>
*/
- List<SavedSearch> getSavedSearches()
- throws TwitterException;
+ List<SavedSearch> getSavedSearches() throws TwitterException;
- /**
+ /**
* Retrieve the data for a saved search owned by the authenticating user specified by the given id.
- * <br>This method calls http://api.twitter.com/1/saved_searches/show/id.json
+ * <br>This method calls http://api.twitter.com/1/saved_searches/show/:id.json
* @param id The id of the saved search to be retrieved.
* @return the data for a saved search
* @throws TwitterException when Twitter service or network is unavailable
* @since Twitter4J 2.0.8
- * @see <a href="http://apiwiki.twitter.com/Twitter-REST-API-Method%3A-saved_searches-show">Twitter API Wiki / Twitter REST API Method: saved_searches show</a>
+ * @see <a href="http://dev.twitter.com/doc/get/saved_searches/show">GET saved_searches/show | dev.twitter.com</a>
*/
- SavedSearch showSavedSearch(int id)
- throws TwitterException;
+ SavedSearch showSavedSearch(int id) throws TwitterException;
- /**
- * Retrieve the data for a saved search owned by the authenticating user specified by the given id.
+ /**
+ * Creates a saved search for the authenticated user.
* <br>This method calls http://api.twitter.com/1/saved_searches/saved_searches/create.json
* @param query the query string
* @return the data for a created saved search
* @throws TwitterException when Twitter service or network is unavailable
* @since Twitter4J 2.0.8
- * @see <a href="http://apiwiki.twitter.com/Twitter-REST-API-Method%3A-saved_searches-create">Twitter API Wiki / Twitter REST API Method: saved_searches create</a>
+ * @see <a href="http://dev.twitter.com/doc/post/saved_searches/create">POST saved_searches/create | dev.twitter.com</a>
*/
SavedSearch createSavedSearch(String query)
throws TwitterException;
@@ -78,7 +76,7 @@ SavedSearch createSavedSearch(String query)
* @return the data for a destroyed saved search
* @throws TwitterException when Twitter service or network is unavailable
* @since Twitter4J 2.0.8
- * @see <a href="http://apiwiki.twitter.com/Twitter-REST-API-Method%3A-saved_searches-destroy">Twitter API Wiki / Twitter REST API Method: saved_searches destroy</a>
+ * @see <a href="http://dev.twitter.com/doc/post/saved_searches/destroy">POST saved_searches/destroy | dev.twitter.com</a>
*/
SavedSearch destroySavedSearch(int id)
throws TwitterException;
View
76 twitter4j-core/src/main/java/twitter4j/api/SearchMethods.java
@@ -40,95 +40,89 @@
public interface SearchMethods {
/**
* Returns tweets that match a specified query.
- * <br>This method calls http://search.twitter.com/search
+ * <br>This method calls http://search.twitter.com/search.json
* @param query - the search condition
* @return the result
* @throws TwitterException when Twitter service or network is unavailable
* @since Twitter4J 1.1.7
- * @see <a href="http://apiwiki.twitter.com/Twitter-Search-API-Method%3A-search">Twitter API Wiki / Twitter Search API Method: search</a>
+ * @see <a href="http://dev.twitter.com/doc/get/search">GET search | dev.twitter.com</a>
+ * @see <a href="http://search.twitter.com/operators">Twitter API / Search Operators</a>
*/
- QueryResult search(Query query)
- throws TwitterException;
+ QueryResult search(Query query) throws TwitterException;
- /**
- * Returns the top ten topics that are currently trending on Twitter. The response includes the time of the request, the name of each trend, and the url to the <a href="http://search.twitter.com/">Twitter Search</a> results page for that topic.
- * <br>This method calls http://search.twitter.com/trends
+ /**
+ * Returns the top ten topics that are currently trending on Twitter. The response includes the time of the request, the name of each trend, and the url to the Twitter Search results page for that topic.
+ * <br>This method calls http://search.twitter.com/trends.json
* @return the result
* @throws TwitterException when Twitter service or network is unavailable
* @since Twitter4J 2.0.2
- * @see <a href="http://apiwiki.twitter.com/Twitter-Search-API-Method%3A-trends">Twitter Search API Method: trends</a>
+ * @see <a href="http://dev.twitter.com/doc/get/trends">GET trends | dev.twitter.com</a>
*/
- Trends getTrends()
- throws TwitterException;
+ Trends getTrends() throws TwitterException;
- /**
- * Returns the current top 10 trending topics on Twitter. The response includes the time of the request, the name of each trending topic, and query used on <a href="http://search.twitter.com/">Twitter Search</a> results page for that topic.
- * <br>This method calls http://search.twitter.com/trends/current
+ /**
+ * Returns the current top 10 trending topics on Twitter. The response includes the time of the request, the name of each trending topic, and query used on Twitter Search results page for that topic.
+ * <br>This method calls http://search.twitter.com/trends/current.json
* @return the result
* @throws TwitterException when Twitter service or network is unavailable
* @since Twitter4J 2.0.2
- * @see <a href="http://apiwiki.twitter.com/Twitter-Search-API-Method%3A-trends">Twitter Search API Method: trends</a>
+ * @see <a href="http://dev.twitter.com/doc/get/trends/current">GET trends/current | dev.twitter.com</a>
*/
- Trends getCurrentTrends()
- throws TwitterException;
+ Trends getCurrentTrends() throws TwitterException;
- /**
- * Returns the current top 10 trending topics on Twitter. The response includes the time of the request, the name of each trending topic, and query used on <a href="http://search.twitter.com/">Twitter Search</a> results page for that topic.
- * <br>This method calls http://search.twitter.com/trends/current
+ /**
+ * Returns the current top 10 trending topics on Twitter. The response includes the time of the request, the name of each trending topic, and query used on Twitter Search results page for that topic.
+ * <br>This method calls http://search.twitter.com/trends/current.json
* @param excludeHashTags Setting this to true will remove all hashtags from the trends list.
* @return the result
* @throws TwitterException when Twitter service or network is unavailable
* @since Twitter4J 2.0.2
- * @see <a href="http://apiwiki.twitter.com/Twitter-Search-API-Method%3A-trends">Twitter Search API Method: trends</a>
+ * @see <a href="http://dev.twitter.com/doc/get/trends/current">GET trends/current | dev.twitter.com</a>
*/
- Trends getCurrentTrends(boolean excludeHashTags)
- throws TwitterException;
+ Trends getCurrentTrends(boolean excludeHashTags) throws TwitterException;
-
- /**
- * Returns the top 20 trending topics for each hour in a given day.
- * <br>This method calls http://search.twitter.com/trends/daily
+ /**
+ * Returns the top 20 trending topics for each hour in a given day.
+ * <br>This method calls http://search.twitter.com/trends/daily.json