Blocks the user specified in the ID parameter as the authenticating user.
Blocks the user specified in the ID parameter as the authenticating user. Returns the blocked user in the requested format when successful.
This method calls twitter4j.Twitter.createBlock(screenName) or createBlock(userId)
createBlock calls http://api.twitter.com/1.1/blocks/create/[id].json
Note1: You must set parameter screenName or userId at least.
Note2: Parameter userId is taken priority over screenName.
the user spcecific information of the user to block
the blocked user
Twitter4S 1.0.0
when specificUser is set null.
TwitterExceptionwhen Twitter service or network is unavailable
Un-blocks the user specified in the ID parameter as the authenticating user.
Un-blocks the user specified in the ID parameter as the authenticating user. Returns the un-blocked user in the requested format when successful.
This method calls twitter4j.Twitter.destroyBlock(screenName) or destroyBlock(userId)
destroyBlock calls http://api.twitter.com/1.1/blocks/destroy/[id].json
Note1: You must set parameter screenName or userId at least.
Note2: Parameter userId is taken priority over screenName.
the user spcecific information of the user to block
the unblocked user
Twitter4S 1.0.0
when specificUser is set null.
TwitterExceptionwhen Twitter service or network is unavailable
Returns the current trend, geo, language, timezone and sleep time information for the authenticating user.
Returns the current trend, geo, language, timezone and sleep time information for the authenticating user.
This method has not been finalized and the interface is subject to change in incompatible ways.
This method calls twitter4j.Twitter.getAccountSettings.
getAccountSettings calls http://api.twitter.com/1.1/account/settings.json
the current trend, geo and sleep time information for the authenticating user.
Twitter4S 1.0.0
when Twitter service or network is unavailable
Returns an array of numeric user ids the authenticating user is blocking.
Returns an array of numeric user ids the authenticating user is blocking.
This method calls twitter4j.Twitter.getBlockingUsersIDs
getBlockingUsersIDs calls http://api.twitter.com/1.1/blocks/ids
Returns an array of numeric user ids the authenticating user is blocking.
Twitter4S 1.0.0
when Twitter service or network is unavailable
Returns a list of user objects that the authenticating user is blocking.
Returns a list of user objects that the authenticating user is blocking.
This method calls twitter4j.Twitter.getBlocksList() or getBlocksList(page)
getBlockingUsers calls http://api.twitter.com/1.1/blocks/blocking.json
(optional) the number of page
a list of user objects that the authenticating user
Twitter4S 1.0.0
when Twitter service or network is unavailable
Returns an array of users that the specified user can contribute to.
Returns an array of users that the specified user can contribute to.
This method calls twitter4j.Twitter.getContributees.
The user id or screen name of the user for whom to return results for
list of contributors
Twitter4S 2.0.0
when Twitter service or network is unavailable
Returns an array of users who can contribute to the specified account.
Returns an array of users who can contribute to the specified account.
This method calls twitter4j.Twitter.getContributors.
The user id or screen name of the user for whom to return results for
list of contributors
Twitter4S 2.0.0
when Twitter service or network is unavailable
Return up to 100 users worth of extended information, specified by either ID, screen name, or combination of the two.
Return up to 100 users worth of extended information, specified by either ID, screen name, or combination of the two. The author's most recent status (if the authenticating user has permission) will be returned inline.
This method calls twitter4j.Twitter.lookupUsers.
lookupUsers calls http://api.twitter.com/1.1/users/lookup.json
Note1: You must set screenNames or ids at least.
Note2: Parameter ids is taken priority over screenNames.
(optional) user specific information(screen names or ids) to return
users
Twitter4S 1.0.0
when Twitter service or network is unavailable
Removes the uploaded profile banner for the authenticating user.
Removes the uploaded profile banner for the authenticating user. Returns HTTP 200 upon success.
This method calls https://api.twitter.com/1.1/account/remove_profile_banner.json
This method calls twitter4j.Twitter.removeProfileBanner
Twitter4S 2.0.0
Run a search for users similar to the Find People button on Twitter.
Run a search for users similar to the Find People button on Twitter.com; the same results returned by people search on Twitter.com will be returned by using this API.
Usage note: It is only possible to retrieve the first 1000 matches from this API.
This method calls twitter4j.Twitter.searchUsers.
searchUsers calls http://api.twitter.com/1.1/users/search.json
The query to run against people search.
Specifies the page of results to retrieve. Number of statuses per page is fixed to 20.
the list of Users matches the provided
Twitter4S 1.0.0
when Twitter service or network is unavailable
Returns extended information of a given user, specified by ID or screen name as per the required id parameter.
Returns extended information of a given user, specified by ID or screen name as per the required id parameter. The author's most recent status will be returned inline.
This method calls twitter4j.Twitter.showUser.
showUser calls http://api.twitter.com/1.1/users/show.json
Note1: You must set screenName or userId at least.
Note2: Parameter userId is taken priority over screenName.
(required) the user specific information(screen name or ID) for whom to request the detail
users
Twitter4S 1.0.0
when specificUser is set null.
TwitterExceptionwhen Twitter service or network is unavailable
Updates the current trend, geo, language, timezone and sleep time information for the authenticating user.
Updates the current trend, geo, language, timezone and sleep time information for the authenticating user.
This method has not been finalized and the interface is subject to change in incompatible ways.
This method calls twitter4j.Twitter.updateAccountSettings.
updateAccountSettings calls http://api.twitter.com/1.1/account/settings.json
Optional. The Yahoo! Where On Earth ID to use as the user's default trend location.
Optional. Whether sleep time is enabled for the user
Optional. The hour that sleep time should begin if it is enabled.
Optional. The hour that sleep time should end if it is enabled.
Optional. The timezone dates and times should be displayed in for the user.
Optional. The language which Twitter should render in for this user. (two letter ISO 639-1)
the current trend, geo and sleep time information for the authenticating user.
Twitter4S 1.0.0
when Twitter service or network is unavailable
Sets values that users are able to set under the "Account" tab of their settings page.
Sets values that users are able to set under the "Account" tab of their settings page. Only the parameters specified(non-null) will be updated.
This method calls twitter4j.Twitter.updateProfile.
updateProfile calls http://api.twitter.com/1.1/account/update_profile.json
Optional. Maximum of 20 characters.
Optional. Maximum of 100 characters. Will be prepended with "http://" if not present.
Optional. Maximum of 30 characters. The contents are not normalized or geocoded in any way.
Optional. Maximum of 160 characters.
the updated user
Twitter4S 1.0.0
when Twitter service or network is unavailable
Updates the authenticating user's profile background image.
Updates the authenticating user's profile background image.
This method calls twitter4.Twitter.updateProfileBackgroundImage.
updateProfileBackgroundImage method calls http://api.twitter.com/1.1/account/update_profile_background_image.json
Note: You must set prameter imageFile or imageStream at least.
Background 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.
(require) Background image as File or Stream object.
(required) If set to true the background image will be displayed tiled. The image will not be tiled otherwise.
the updated user
Twitter4S 1.0.0
when Twitter service or network is unavailable, or when the specified file is not found (FileNotFoundException will be nested), or when the specified file object in not representing a file (IOException will be nested)
POST account/update_profile_background_image | Twitter Developers
Uploads a profile banner on behalf of the authenticating user.
Uploads a profile banner on behalf of the authenticating user. For best results, upload an <5MB image that is exactly 1252px by 626px. Images will be resized for a number of display options. Users with an uploaded profile banner will have a profile_banner_url node in their Users objects. More information about sizing variations can be found in User Profile Images and Banners.
Profile banner images are processed asynchronously. The profile_banner_url and its variant sizes will not necessary be available directly after upload.
This method calls https://api.twitter.com/1.1/account/update_profile_banner.json
This method calls twitter4j.Twitter.updateProfileBanner
(File or FileStream) For best results, upload an <5MB image that is exactly 1252px by 626px.
Twitter4S 2.0.0
when Twitter service or network is unavailable, or when the specified file is not found (FileNotFoundException will be nested), or when the specified file object in not representing a file (IOException will be nested)
Sets one or more hex values that control the color scheme of the authenticating user's profile page on twitter.
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).
This method calls twitter4j.Twitter.updateProfileColors.
updateProfileColors calls http://api.twitter.com/1.1/account/update_profile_colors.json
optional, can be null
optional, can be null
optional, can be null
optional, can be null
optional, can be null
the updated user
Twitter4S 1.0.0
when Twitter service or network is unavailable
Updates the authenticating user's profile image.
Updates the authenticating user's profile image.
This method calls twitter4j.Twitter.updateProfileImage.
updateProfileImage calls http://api.twitter.com/1.1/account/update_profile_image.json
Note: You must set parameter imageFile or imageStream at least.
Profile image must be a valid GIF, JPG, or PNG image of less than 700 kilobytes in size. Images with width larger than 500 pixels will be scaled down.
(require) Profile image as File or Stream object.
the updated user
Twitter4S 1.0.0
when Twitter service or network is unavailable, or when the specified file is not found (FileNotFoundException will be nested), or when the specified file object in not representing a file (IOException will be nested).
Returns an HTTP 200 OK response code and a representation of the requesting user if authentication was successful; returns a 401 status code and an error message if not.
Returns an HTTP 200 OK response code and a representation of the requesting user if authentication was successful; returns a 401 status code and an error message if not. Use this method to test if supplied user credentials are valid.
This method calls twitter4j.Twitter.verifyCredentials.
verifyCredentials calls http://api.twitter.com/1.1/account/verify_credentials.json
user
Twitter4S 1.0.0
when Twitter service or network is unavailable, or if supplied credential is wrong (TwitterException.getStatusCode() == 401)