| ADDLISTSUBSCRIBER |
| Application Scope - function addListSubscriber |
|---|
Arguments:
| Name |
Required |
Type |
Default |
| owner_screen_name |
Optional |
string |
[empty string] |
| owner_id |
Optional |
string |
[empty string] |
| list_id |
Optional |
string |
[empty string] |
| slug |
Optional |
String |
[empty string] |
| checkHeader |
Optional |
boolean |
false |
| timeout |
Optional |
string |
[runtime expression] |
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Subscribes the authenticated user to the specified list. |
| Description: |
|
|
|
| ADDMEMBERTOLIST |
| Application Scope - function addMemberToList |
|---|
Arguments:
| Name |
Required |
Type |
Default |
| list_id |
Required |
string |
|
| slug |
Required |
String |
[empty string] |
| user_id |
Optional |
String |
[empty string] |
| screen_name |
Optional |
String |
[empty string] |
| owner_screen_name |
Optional |
string |
[empty string] |
| owner_id |
Optional |
string |
[empty string] |
| checkHeader |
Optional |
boolean |
false |
| timeout |
Optional |
string |
[runtime expression] |
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Add a member to a list. The authenticated user must own the list to be able to add members to it. Lists are limited to having 500 members. |
| Description: |
|
|
|
| ADDMULTIPLEMEMBERSTOLIST |
| Application Scope - function addMultipleMembersToList |
|---|
Arguments:
| Name |
Required |
Type |
Default |
| list_id |
Optional |
string |
[empty string] |
| slug |
Optional |
String |
[empty string] |
| user_id |
Optional |
String |
[empty string] |
| screen_name |
Optional |
String |
[empty string] |
| owner_screen_name |
Optional |
string |
[empty string] |
| owner_id |
Optional |
string |
[empty string] |
| checkHeader |
Optional |
boolean |
false |
| timeout |
Optional |
string |
[runtime expression] |
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Adds multiple members to a list, by specifying a comma-separated list of member ids or screen names. The authenticated user must own the list to be able to add members to it. Note that lists can't have more than 500 members, and you are limited to adding up to 100 members to a list at a time with this method. |
| Description: |
|
|
|
| ADDTOFAVORITES |
| Application Scope - function addToFavorites |
|---|
Arguments:
| Name |
Required |
Type |
Default |
| id |
Required |
string |
|
| include_entities |
Optional |
Boolean |
false |
| checkHeader |
Optional |
boolean |
false |
| timeout |
Optional |
string |
[runtime expression] |
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Favorites the status specified in the ID parameter as the authenticating user. Returns the favorite status when successful. |
| Description: |
|
|
|
| ANYWHERESCRIPTHEADER |
| Application Scope - function anywhereScriptHeader |
|---|
Arguments:
| Name |
Required |
Type |
Default |
| consumerKey |
Required |
string |
[runtime expression] |
|
| ReturnType: |
String
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
I return the required script tag for the @Anywhere api. |
| Description: |
|
|
|
| AVAILABLETRENDS |
| Application Scope - function availableTrends |
|---|
Arguments:
| Name |
Required |
Type |
Default |
| lat |
Optional |
String |
[empty string] |
| long |
Optional |
String |
[empty string] |
| checkHeader |
Optional |
boolean |
false |
| timeout |
Optional |
string |
[runtime expression] |
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Returns the locations that Twitter has trending topic information for. The response is an array of 'locations' that encode the location's WOEID (a Yahoo! Where On Earth ID) and some other human-readable information such as a canonical name and country the location belongs in. |
| Description: |
|
|
|
| BLOCKUSER |
| Application Scope - function blockUser |
|---|
Arguments:
| Name |
Required |
Type |
Default |
| user_id |
Optional |
string |
|
| screen_name |
Optional |
string |
|
| include_entities |
Optional |
Boolean |
|
| skip_status |
Optional |
string |
[empty string] |
| checkHeader |
Optional |
boolean |
false |
| timeout |
Optional |
string |
[runtime expression] |
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Blocks the user specified in the ID parameter as the authenticating user. Destroys a friendship to the blocked user if it exists. Returns the blocked user in the requested format when successful |
| Description: |
|
|
|
| BUILDPARAMSTRING |
| Application Scope - function buildParamString |
|---|
Arguments:
| Name |
Required |
Type |
Default |
| argScope |
Required |
struct |
|
|
| ReturnType: |
String
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
I loop through a struct to convert to query params for the URL |
| Description: |
|
|
|
| CHECKLISTMEMBER |
| Application Scope - function checkListMember |
|---|
Arguments:
| Name |
Required |
Type |
Default |
| list_id |
Optional |
string |
[empty string] |
| slug |
Optional |
String |
[empty string] |
| user_id |
Optional |
String |
[empty string] |
| screen_name |
Optional |
String |
[empty string] |
| owner_screen_name |
Optional |
string |
[empty string] |
| owner_id |
Optional |
string |
[empty string] |
| include_entities |
Optional |
Boolean |
|
| skip_status |
Optional |
string |
[empty string] |
| checkHeader |
Optional |
boolean |
false |
| timeout |
Optional |
string |
[runtime expression] |
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Check if the specified user is a member of the specified list. |
| Description: |
|
|
|
| CHECKMEDIA |
| Application Scope - function checkMedia |
|---|
Arguments:
| Name |
Required |
Type |
Default |
| file |
Required |
any |
|
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
package |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Check the media to be uploaded into the status update. |
| Description: |
|
|
|
| CLEAREMPTYPARAMS |
| Application Scope - function clearEmptyParams |
|---|
Arguments:
| Name |
Required |
Type |
Default |
| paramStructure |
Required |
Struct |
|
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
I accept the structure of arguments and remove any empty / nulls values before they are sent to the OAuth processing. |
| Description: |
|
|
|
| CLOSESTTRENDS |
| Application Scope - function closestTrends |
|---|
Arguments:
| Name |
Required |
Type |
Default |
| lat |
Optional |
String |
[empty string] |
| long |
Optional |
String |
[empty string] |
| checkHeader |
Optional |
boolean |
false |
| timeout |
Optional |
string |
[runtime expression] |
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Returns the locations that Twitter has trending topic information for, closest to a specified location. The response is an array of 'locations' that encode the location's WOEID and some other human-readable information such as a canonical name and country the location belongs in. |
| Description: |
|
|
|
| CONFIGURATION |
| Application Scope - function configuration |
|---|
Arguments:
| Name |
Required |
Type |
Default |
| timeout |
Optional |
string |
[runtime expression] |
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Returns the current configuration used by Twitter including twitter.com slugs which are not usernames, maximum photo resolutions, and t.co URL lengths. It is recommended applications request this endpoint when they are loaded, but no more than once a day. |
| Description: |
|
|
|
| CREATEDM |
| Application Scope - function createDM |
|---|
Arguments:
| Name |
Required |
Type |
Default |
| screen_name |
Optional |
string |
|
| user_id |
Optional |
string |
|
| text |
Required |
string |
|
| checkHeader |
Optional |
boolean |
false |
| timeout |
Optional |
string |
[runtime expression] |
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Sends a new direct message to the specified user from the authenticating user. Requires both the user and text parameters. Request must be a POST. Returns the sent message in the requested format when successful. |
| Description: |
|
|
|
| CREATELIST |
| Application Scope - function createList |
|---|
Arguments:
| Name |
Required |
Type |
Default |
| name |
Required |
string |
|
| mode |
Optional |
string |
public |
| description |
Optional |
string |
|
| checkHeader |
Optional |
boolean |
false |
| timeout |
Optional |
string |
[runtime expression] |
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Creates a new list for the authenticated user. Note that you can't create more than 20 lists per account. |
| Description: |
|
|
|
| CREATEPLACE |
| Application Scope - function createPlace |
|---|
Arguments:
| Name |
Required |
Type |
Default |
| name |
Required |
string |
|
| contained_within |
Required |
string |
|
| token |
Optional |
string |
|
| lat |
Optional |
string |
|
| long |
Optional |
string |
|
| street_address |
Optional |
String |
|
| callback |
Optional |
string |
|
| checkHeader |
Optional |
boolean |
false |
| timeout |
Optional |
string |
[runtime expression] |
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Creates a new place object at the given latitude and longitude. Before creating a place you need to query GET geo/similar_places with the latitude, longitude and name of the place you wish to create. The query will return an array of places which are similar to the one you wish to create, and a token. If the place you wish to create isn't in the returned array you can use the token with this method to create a new one. |
| Description: |
|
|
|
| DELETEDM |
| Application Scope - function deleteDM |
|---|
Arguments:
| Name |
Required |
Type |
Default |
| id |
Required |
string |
|
| include_entities |
Optional |
Boolean |
false |
| checkHeader |
Optional |
boolean |
false |
| timeout |
Optional |
string |
[runtime expression] |
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Destroys the direct message specified in the required ID parameter. The authenticating user must be the recipient of the specified direct message. |
| Description: |
|
|
|
| DELETELIST |
| Application Scope - function deleteList |
|---|
Arguments:
| Name |
Required |
Type |
Default |
| owner_screen_name |
Optional |
string |
[empty string] |
| owner_id |
Optional |
string |
[empty string] |
| list_id |
Optional |
string |
[empty string] |
| slug |
Optional |
String |
[empty string] |
| checkHeader |
Optional |
boolean |
false |
| timeout |
Optional |
string |
[runtime expression] |
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Deletes the specified list. The authenticated user must own the list to be able to destroy it. |
| Description: |
|
|
|
| DELETELISTMEMBER |
| Application Scope - function deleteListMember |
|---|
Arguments:
| Name |
Required |
Type |
Default |
| list_id |
Optional |
string |
[empty string] |
| slug |
Optional |
String |
[empty string] |
| user_id |
Optional |
String |
[empty string] |
| screen_name |
Optional |
String |
[empty string] |
| owner_screen_name |
Optional |
string |
[empty string] |
| owner_id |
Optional |
string |
[empty string] |
| checkHeader |
Optional |
boolean |
false |
| timeout |
Optional |
string |
[runtime expression] |
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Removes the specified member from the list. The authenticated user must be the list's owner to remove members from the list. |
| Description: |
|
|
|
| DELETELISTSUBSCRIBER |
| Application Scope - function deleteListSubscriber |
|---|
Arguments:
| Name |
Required |
Type |
Default |
| list_id |
Optional |
string |
[empty string] |
| slug |
Optional |
String |
[empty string] |
| owner_screen_name |
Optional |
string |
[empty string] |
| owner_id |
Optional |
string |
[empty string] |
| checkHeader |
Optional |
boolean |
false |
| timeout |
Optional |
string |
[runtime expression] |
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Unsubscribes the authenticated user form the specified list. |
| Description: |
|
|
|
| DELETESAVEDSEARCH |
| Application Scope - function deleteSavedSearch |
|---|
Arguments:
| Name |
Required |
Type |
Default |
| id |
Required |
string |
|
| checkHeader |
Optional |
boolean |
false |
| timeout |
Optional |
string |
[runtime expression] |
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Destroys a saved search for the authenticating user. The authenticating user must be the owner of saved search id being destroyed. |
| Description: |
|
|
|
| DELETESTATUS |
| Application Scope - function deleteStatus |
|---|
Arguments:
| Name |
Required |
Type |
Default |
| id |
Required |
string |
|
| trim_user |
Optional |
Boolean |
false |
| checkHeader |
Optional |
boolean |
false |
| timeout |
Optional |
string |
[runtime expression] |
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Destroys the status specified by the required ID parameter. The authenticating user must be the author of the specified status. |
| Description: |
|
|
|
| DESTORYALLLISTMEMBERS |
| Application Scope - function destoryAllListMembers |
|---|
Arguments:
| Name |
Required |
Type |
Default |
| list_id |
Optional |
string |
[empty string] |
| slug |
Optional |
string |
[empty string] |
| user_id |
Optional |
string |
[empty string] |
| screen_name |
Optional |
string |
[empty string] |
| owner_screen_name |
Optional |
string |
[empty string] |
| owner_id |
Optional |
string |
[empty string] |
| checkHeader |
Optional |
boolean |
false |
| timeout |
Optional |
string |
[runtime expression] |
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Removes multiple members from a list, by specifying a comma-separated list of member ids or screen names. The authenticated user must own the list to be able to remove members from it. Note that lists can't have more than 500 members, and you are limited to removing up to 100 members to a list at a time with this method. Please note that there can be issues with lists that rapidly remove and add memberships. Take care when using these methods such that you are not too rapidly switching between removals and adds on the same list. |
| Description: |
|
|
|
| ENTIFY |
| Application Scope - function entify |
|---|
Arguments:
| Name |
Required |
Type |
Default |
| tweetStruct |
Required |
struct |
|
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
I convert all user mentions, links and hashtags to HTML URLs for display. |
| Description: |
|
|
|
| FAVORITES |
| Application Scope - function favorites |
|---|
Arguments:
| Name |
Required |
Type |
Default |
| user_id |
Optional |
string |
|
| screen_name |
Optional |
string |
|
| count |
Optional |
string |
200 |
| since_id |
Optional |
string |
[empty string] |
| max_id |
Optional |
string |
[empty string] |
| include_entities |
Optional |
Boolean |
false |
| checkHeader |
Optional |
boolean |
false |
| timeout |
Optional |
string |
[runtime expression] |
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Returns the 20 most recent Tweets favorited by the authenticating or specified user. |
| Description: |
|
|
|
| FOLLOWBUTTON |
| Application Scope - function followButton |
|---|
Arguments:
| Name |
Required |
Type |
Default |
| htmlSection |
Required |
string |
|
| twittername |
Required |
string |
|
| individual |
Optional |
boolean |
true |
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Follow buttons make it easy to provide users of your site or application with a way to follow users on Twitter. |
| Description: |
|
|
|
| FOLLOWUSER |
| Application Scope - function followUser |
|---|
Arguments:
| Name |
Required |
Type |
Default |
| user_id |
Optional |
string |
|
| screen_name |
Optional |
string |
|
| follow |
Optional |
string |
|
| checkHeader |
Optional |
boolean |
false |
| timeout |
Optional |
string |
[runtime expression] |
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Allows the authenticating users to follow the user specified in the ID parameter. 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. |
| Description: |
|
|
|
| GENERICAUTHENTICATIONMETHOD |
| Application Scope - function genericAuthenticationMethod |
|---|
Arguments:
| Name |
Required |
Type |
Default |
| httpURL |
Required |
String |
|
| httpMethod |
Required |
String |
POST |
| parameters |
Optional |
Struct |
[runtime expression] |
| checkHeader |
Optional |
boolean |
false |
| timeout |
Optional |
string |
[runtime expression] |
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
I accept the URL, method and parameters and make the required authenticated call to the API. |
| Description: |
|
|
|
| GENERICAUTHENTICATIONMETHOD1 |
| Application Scope - function genericAuthenticationMethod1 |
|---|
Arguments:
| Name |
Required |
Type |
Default |
| httpURL |
Required |
String |
|
| httpMethod |
Required |
String |
POST |
| parameters |
Optional |
Struct |
[runtime expression] |
| checkHeader |
Optional |
boolean |
false |
| timeout |
Optional |
string |
[runtime expression] |
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
I accept the URL, method and parameters and make the required authenticated call to the API. |
| Description: |
|
|
|
| GEOGETPLACEBYID |
| Application Scope - function geoGetPlaceByID |
|---|
Arguments:
| Name |
Required |
Type |
Default |
| place_id |
Required |
String |
|
| checkHeader |
Optional |
boolean |
false |
| timeout |
Optional |
string |
[runtime expression] |
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Returns all the information about a known place. |
| Description: |
|
|
|
| GEOREVERSEGEOCODE |
| Application Scope - function geoReverseGeocode |
|---|
Arguments:
| Name |
Required |
Type |
Default |
| lat |
Required |
String |
|
| long |
Required |
String |
|
| granularity |
Optional |
String |
|
| accuracy |
Optional |
String |
|
| max_results |
Optional |
String |
|
| callback |
Optional |
String |
|
| checkHeader |
Optional |
boolean |
false |
| timeout |
Optional |
string |
[runtime expression] |
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Given a latitude and a longitude, searches for up to 20 places that can be used as a place_id when updating a status. This request is an informative call and will deliver generalized results about geography. |
| Description: |
|
|
|
| GEOSEARCH |
| Application Scope - function geoSearch |
|---|
Arguments:
| Name |
Required |
Type |
Default |
| lat |
Optional |
String |
|
| long |
Optional |
String |
|
| query |
Optional |
String |
|
| ip |
Optional |
String |
|
| granularity |
Optional |
String |
|
| accuracy |
Optional |
String |
|
| max_results |
Optional |
String |
|
| contained_within |
Optional |
String |
|
| street_address |
Optional |
String |
|
| callback |
Optional |
String |
|
| checkHeader |
Optional |
boolean |
false |
| timeout |
Optional |
string |
[runtime expression] |
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Search for places that can be attached to a statuses/update. Given a latitude and a longitude pair, an IP address, or a name, this request will return a list of all the valid places that can be used as the place_id when updating a status. |
| Description: |
|
|
|
| GEOSIMILARPLACES |
| Application Scope - function geoSimilarPlaces |
|---|
Arguments:
| Name |
Required |
Type |
Default |
| lat |
Required |
String |
|
| long |
Required |
String |
|
| name |
Required |
String |
|
| contained_within |
Optional |
String |
|
| street_address |
Optional |
String |
|
| callback |
Optional |
String |
|
| checkHeader |
Optional |
boolean |
false |
| timeout |
Optional |
string |
[runtime expression] |
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Locates places near the given coordinates which are similar in name. |
| Description: |
|
|
|
| GETACCESSTOKEN |
| Application Scope - function getAccessToken |
|---|
Arguments:
| Name |
Required |
Type |
Default |
| requestToken |
Required |
string |
|
| requestSecret |
Required |
string |
|
| verifier |
Required |
string |
|
| timeout |
Optional |
string |
[runtime expression] |
|
| ReturnType: |
Struct
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Gets an Access Token which can be stored and used for future access. |
| Description: |
|
|
|
| GETACCOUNTSETTINGS |
| Application Scope - function getAccountSettings |
|---|
Arguments:
| Name |
Required |
Type |
Default |
| checkHeader |
Optional |
boolean |
false |
| timeout |
Optional |
string |
[runtime expression] |
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Returns settings (including current trend, geo and sleep time information) for the authenticating user. |
| Description: |
|
|
|
| GETALLLISTS |
| Application Scope - function getAllLists |
|---|
Arguments:
| Name |
Required |
Type |
Default |
| user_id |
Optional |
string |
|
| screen_name |
Optional |
string |
|
| checkHeader |
Optional |
boolean |
false |
| timeout |
Optional |
string |
[runtime expression] |
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Returns all lists the authenticating or specified user subscribes to, including their own. The user is specified using the user_id or screen_name parameters. If no user is given, the authenticating user is used. |
| Description: |
|
|
|
| GETAPIENDPOINT |
| Application Scope - function getapiEndpoint |
|---|
| Arguments: | none |
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
I return the api endpoint for use in the OAuth method calls. |
| Description: |
|
|
|
| GETAPIURL |
| Application Scope - function getapiURL |
|---|
| Arguments: | none |
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
I return the api url for use in the method calls. |
| Description: |
|
|
|
| GETAPPLICATIONRATELIMITSTATUS |
| Application Scope - function getApplicationRateLimitStatus |
|---|
Arguments:
| Name |
Required |
Type |
Default |
| timeout |
Optional |
string |
[runtime expression] |
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Returns the current rate limits for methods belonging to the specified resource families. |
| Description: |
|
|
|
| GETAUTHDETAILS |
| Application Scope - function getAuthDetails |
|---|
| Arguments: | none |
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
I get the twitter account access details |
| Description: |
|
|
|
| GETAUTHORISATION |
| Application Scope - function getAuthorisation |
|---|
Arguments:
| Name |
Required |
Type |
Default |
| callBackURL |
Optional |
string |
[empty string] |
| timeout |
Optional |
string |
[runtime expression] |
|
| ReturnType: |
struct
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
I make the call to Twitter to request authorisation to access the account. |
| Description: |
|
|
|
| GETBASEURL |
| Application Scope - function getbaseURL |
|---|
| Arguments: | none |
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
I return the base url for use in the method calls. |
| Description: |
|
|
|
| GETBLOCKEDUSERS |
| Application Scope - function getBlockedUsers |
|---|
Arguments:
| Name |
Required |
Type |
Default |
| include_entities |
Optional |
Boolean |
true |
| skip_status |
Optional |
string |
[empty string] |
| cursor |
Optional |
string |
[empty string] |
| checkHeader |
Optional |
boolean |
false |
| timeout |
Optional |
string |
[runtime expression] |
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Returns an array of user objects that the authenticating user is blocking. Consider using GET blocks/blocking/ids with GET users/lookup instead of this method. |
| Description: |
|
|
|
| GETBLOCKINGIDS |
| Application Scope - function getBlockingIDs |
|---|
Arguments:
| Name |
Required |
Type |
Default |
| stringify_ids |
Optional |
Boolean |
false |
| cursor |
Optional |
string |
[empty string] |
| checkHeader |
Optional |
boolean |
false |
| timeout |
Optional |
string |
[runtime expression] |
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Returns a collection of user objects that the authenticating user is blocking. |
| Description: |
|
|
|
| GETCONSUMERKEY |
| Application Scope - function getConsumerKey |
|---|
| Arguments: | none |
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
I return the consumer key from the variables.instance struct. |
| Description: |
|
|
|
| GETCONSUMERSECRET |
| Application Scope - function getConsumerSecret |
|---|
| Arguments: | none |
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
I return the consumer secret from the variables.instance struct. |
| Description: |
|
|
|
| GETCORRECTENDPOINT |
| Application Scope - function getCorrectEndpoint |
|---|
Arguments:
| Name |
Required |
Type |
Default |
| endpointRef |
Required |
string |
|
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
package |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
I return the correct URL string which creates the beginning of the API endpoint. |
| Description: |
|
|
|
| GETDIRECTMESSAGES |
| Application Scope - function getDirectMessages |
|---|
Arguments:
| Name |
Required |
Type |
Default |
| since_id |
Optional |
string |
[empty string] |
| max_id |
Optional |
string |
[empty string] |
| count |
Optional |
string |
200 |
| page |
Optional |
string |
[empty string] |
| include_entities |
Optional |
Boolean |
false |
| skip_status |
Optional |
string |
[empty string] |
| checkHeader |
Optional |
boolean |
false |
| timeout |
Optional |
string |
[runtime expression] |
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Returns a list of the 20 most recent direct messages sent to the authenticating user. The XML and JSON versions include detailed information about the sending and recipient users. |
| Description: |
|
|
|
| GETDIRECTMESSAGESBYID |
| Application Scope - function getDirectMessagesByID |
|---|
Arguments:
| Name |
Required |
Type |
Default |
| id |
Required |
string |
[empty string] |
| checkHeader |
Optional |
boolean |
false |
| timeout |
Optional |
string |
[runtime expression] |
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Returns a single direct message, specified by an id parameter. Like the /1/direct_messages.format request, this method will include the user objects of the sender and recipient. |
| Description: |
|
|
|
| GETDIRECTMESSAGESSENT |
| Application Scope - function getDirectMessagesSent |
|---|
Arguments:
| Name |
Required |
Type |
Default |
| since_id |
Optional |
string |
[empty string] |
| max_id |
Optional |
string |
[empty string] |
| count |
Optional |
string |
200 |
| page |
Optional |
Any |
[empty string] |
| include_entities |
Optional |
Boolean |
false |
| checkHeader |
Optional |
boolean |
false |
| timeout |
Optional |
string |
[runtime expression] |
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Returns a list of the 20 most recent direct messages sent by the authenticating user. The XML and JSON versions include detailed information about the sending and recipient users. |
| Description: |
|
|
|
| GETFOLLOWERSIDS |
| Application Scope - function getFollowersIDs |
|---|
Arguments:
| Name |
Required |
Type |
Default |
| user_id |
Optional |
string |
|
| screen_name |
Optional |
string |
|
| cursor |
Optional |
string |
-1 |
| stringify_ids |
Optional |
boolean |
false |
| count |
Optional |
string |
200 |
| checkHeader |
Optional |
boolean |
false |
| timeout |
Optional |
string |
[runtime expression] |
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Returns an array of numeric IDs for every user following the specified user. This method is powerful when used in conjunction with users/lookup. |
| Description: |
|
|
|
| GETFOLLOWERSLIST |
| Application Scope - function getFollowersList |
|---|
Arguments:
| Name |
Required |
Type |
Default |
| user_id |
Optional |
string |
|
| screen_name |
Optional |
string |
|
| cursor |
Optional |
string |
-1 |
| count |
Optional |
string |
20 |
| skip_status |
Optional |
boolean |
|
| include_user_entities |
Optional |
boolean |
|
| checkHeader |
Optional |
boolean |
false |
| timeout |
Optional |
string |
[runtime expression] |
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Returns a cursored collection of user objects for users following the specified user. At this time, results are ordered with the most recent following first — however, this ordering is subject to unannounced change and eventual consistency issues. Results are given in groups of 20 users and multiple 'pages' of results can be navigated through using the next_cursor value in subsequent requests. |
| Description: |
|
|
|
| GETFRIENDSHIPSLOOKUP |
| Application Scope - function getFriendshipsLookup |
|---|
Arguments:
| Name |
Required |
Type |
Default |
| screen_name |
Optional |
string |
|
| user_id |
Optional |
string |
|
| checkHeader |
Optional |
boolean |
false |
| timeout |
Optional |
string |
[runtime expression] |
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Returns the relationship of the authenticating user to the comma separated list of up to 100 screen_names or user_ids provided. Values for connections can be: following, following_requested, followed_by, none. |
| Description: |
|
|
|
| GETFRIENDSIDS |
| Application Scope - function getFriendsIDs |
|---|
Arguments:
| Name |
Required |
Type |
Default |
| user_id |
Optional |
string |
|
| screen_name |
Optional |
string |
|
| cursor |
Optional |
string |
-1 |
| stringify_ids |
Optional |
boolean |
false |
| count |
Optional |
string |
200 |
| checkHeader |
Optional |
boolean |
false |
| timeout |
Optional |
string |
[runtime expression] |
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Returns an array of numeric IDs for every user the specified user is following. This method is powerful when used in conjunction with users/lookup. |
| Description: |
|
|
|
| GETFRIENDSLIST |
| Application Scope - function getFriendsList |
|---|
Arguments:
| Name |
Required |
Type |
Default |
| user_id |
Optional |
string |
|
| screen_name |
Optional |
string |
|
| cursor |
Optional |
string |
-1 |
| count |
Optional |
string |
20 |
| skip_status |
Optional |
boolean |
|
| include_user_entities |
Optional |
boolean |
|
| checkHeader |
Optional |
boolean |
false |
| timeout |
Optional |
string |
[runtime expression] |
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Returns a cursored collection of user objects for every user the specified user is following (otherwise known as their 'friends'). At this time, results are ordered with the most recent following first — however, this ordering is subject to unannounced change and eventual consistency issues. Results are given in groups of 20 users and multiple 'pages' of results can be navigated through using the next_cursor value in subsequent requests. |
| Description: |
|
|
|
| GETFRIENDSNORETWEETSIDS |
| Application Scope - function getFriendsNoRetweetsIDs |
|---|
Arguments:
| Name |
Required |
Type |
Default |
| stringify_ids |
Optional |
boolean |
false |
| checkHeader |
Optional |
boolean |
false |
| timeout |
Optional |
string |
[runtime expression] |
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Returns a collection of user_ids that the currently authenticated user does not want to receive retweets from. Use POST friendships/update to set the 'no retweets' status for a given user account on behalf of the current user. |
| Description: |
|
|
|
| GETHOMETIMELINE |
| Application Scope - function getHomeTimeline |
|---|
Arguments:
| Name |
Required |
Type |
Default |
| count |
Optional |
string |
[empty string] |
| since_id |
Optional |
string |
[empty string] |
| max_id |
Optional |
string |
[empty string] |
| trim_user |
Optional |
string |
[empty string] |
| exclude_replies |
Optional |
string |
[empty string] |
| contributor_details |
Optional |
string |
[empty string] |
| include_entities |
Optional |
string |
[empty string] |
| checkHeader |
Optional |
boolean |
false |
| timeout |
Optional |
string |
[runtime expression] |
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Returns the 20 most recent statuses, including retweets, posted by the authenticating user and that user's friends. This is the equivalent of /timeline/home on the Web. Usage note: This home_timeline is identical to statuses/friends_timeline except it also contains retweets, which statuses/friends_timeline does not (for backwards compatibility reasons). |
| Description: |
|
|
|
| GETINCOMINGFRIENDSHIPS |
| Application Scope - function getIncomingFriendships |
|---|
Arguments:
| Name |
Required |
Type |
Default |
| cursor |
Optional |
string |
|
| stringify_ids |
Optional |
boolean |
false |
| checkHeader |
Optional |
boolean |
false |
| timeout |
Optional |
string |
[runtime expression] |
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Returns an array of numeric IDs for every user who has a pending request to follow the authenticating user. |
| Description: |
|
|
|
| GETLEGALTOS |
| Application Scope - function getLegalTOS |
|---|
Arguments:
| Name |
Required |
Type |
Default |
| timeout |
Optional |
string |
[runtime expression] |
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Returns Twitter's' Terms of Service in the requested format. These are not the same as the Developer Terms of Service. |
| Description: |
|
|
|
| GETLISTBYID |
| Application Scope - function getListByID |
|---|
Arguments:
| Name |
Required |
Type |
Default |
| list_id |
Optional |
string |
[empty string] |
| slug |
Optional |
String |
[empty string] |
| owner_screen_name |
Optional |
string |
[empty string] |
| owner_id |
Optional |
string |
[empty string] |
| checkHeader |
Optional |
boolean |
false |
| timeout |
Optional |
string |
[runtime expression] |
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Returns the specified list. Private lists will only be shown if the authenticated user owns the specified list. |
| Description: |
|
|
|
| GETLISTMEMBERS |
| Application Scope - function getListMembers |
|---|
Arguments:
| Name |
Required |
Type |
Default |
| list_id |
Required |
string |
|
| cursor |
Optional |
string |
-1 |
| include_entities |
Optional |
Boolean |
|
| checkHeader |
Optional |
boolean |
false |
| timeout |
Optional |
string |
[runtime expression] |
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Returns the members of the specified list. |
| Description: |
|
|
|
| GETLISTMEMBERSHIPS |
| Application Scope - function getListMemberships |
|---|
Arguments:
| Name |
Required |
Type |
Default |
| user_id |
Optional |
String |
[empty string] |
| screen_name |
Optional |
String |
[empty string] |
| cursor |
Optional |
string |
-1 |
| filter_to_owned_lists |
Optional |
boolean |
false |
| checkHeader |
Optional |
boolean |
false |
| timeout |
Optional |
string |
[runtime expression] |
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
List the lists the specified user has been added to. |
| Description: |
|
|
|
| GETLISTOWNERSHIPS |
| Application Scope - function getListOwnerships |
|---|
Arguments:
| Name |
Required |
Type |
Default |
| user_id |
Optional |
string |
[empty string] |
| screen_name |
Optional |
string |
[empty string] |
| count |
Optional |
string |
20 |
| cursor |
Optional |
string |
-1 |
| checkHeader |
Optional |
boolean |
false |
| timeout |
Optional |
string |
[runtime expression] |
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Returns the lists owned by the specified Twitter user. Private lists will only be shown if the authenticated user is also the owner of the lists. |
| Description: |
|
|
|
| GETLISTSTATUSES |
| Application Scope - function getListStatuses |
|---|
Arguments:
| Name |
Required |
Type |
Default |
| list_id |
Required |
string |
[empty string] |
| slug |
Optional |
string |
[empty string] |
| owner_screen_name |
Optional |
string |
[empty string] |
| owner_id |
Optional |
string |
[empty string] |
| since_id |
Optional |
string |
[empty string] |
| max_id |
Optional |
string |
[empty string] |
| count |
Optional |
string |
[empty string] |
| include_entities |
Optional |
string |
[empty string] |
| include_rts |
Optional |
string |
[empty string] |
| checkHeader |
Optional |
boolean |
false |
| timeout |
Optional |
string |
[runtime expression] |
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Returns tweet timeline for members of the specified list. Historically, retweets were not available in list timeline responses but you can now use the include_rts=true parameter to additionally receive retweet objects. |
| Description: |
|
|
|
| GETLISTSUBSCRIBERS |
| Application Scope - function getListSubscribers |
|---|
Arguments:
| Name |
Required |
Type |
Default |
| list_id |
Required |
string |
[empty string] |
| slug |
Optional |
String |
[empty string] |
| owner_screen_name |
Optional |
string |
[empty string] |
| owner_id |
Optional |
string |
[empty string] |
| cursor |
Optional |
string |
-1 |
| include_entities |
Optional |
Boolean |
|
| skip_status |
Optional |
string |
[empty string] |
| checkHeader |
Optional |
boolean |
false |
| timeout |
Optional |
string |
[runtime expression] |
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Returns the subscribers of the specified list. |
| Description: |
|
|
|
| GETLISTSUBSCRIPTIONS |
| Application Scope - function getListSubscriptions |
|---|
Arguments:
| Name |
Required |
Type |
Default |
| user_id |
Optional |
string |
[empty string] |
| screen_name |
Optional |
string |
[empty string] |
| count |
Optional |
string |
20 |
| cursor |
Optional |
string |
-1 |
| checkHeader |
Optional |
boolean |
false |
| timeout |
Optional |
string |
[runtime expression] |
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Obtain a collection of the lists the specified user is subscribed to, 20 lists per page by default. Does not include the user's own lists. |
| Description: |
|
|
|
| GETMAGICMIME |
| Application Scope - function getMagicMime |
|---|
Arguments:
| Name |
Required |
Type |
Default |
| filePath |
Required |
Any |
|
|
| ReturnType: |
struct
|
| Roles: |
|
| Access: |
package |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETMENTIONS |
| Application Scope - function getMentions |
|---|
Arguments:
| Name |
Required |
Type |
Default |
| count |
Optional |
string |
[empty string] |
| since_id |
Optional |
string |
[empty string] |
| max_id |
Optional |
string |
[empty string] |
| trim_user |
Optional |
string |
[empty string] |
| contributor_details |
Optional |
string |
[empty string] |
| include_entities |
Optional |
string |
[empty string] |
| checkHeader |
Optional |
boolean |
false |
| timeout |
Optional |
string |
[runtime expression] |
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Returns the 20 most recent mentions (status containing @username) for the authenticating user. |
| Description: |
|
|
|
| GETOEMBED |
| Application Scope - function getOEmbed |
|---|
Arguments:
| Name |
Required |
Type |
Default |
| id |
Optional |
string |
[empty string] |
| url |
Optional |
string |
[empty string] |
| maxwidth |
Optional |
string |
|
| hide_media |
Optional |
string |
|
| hide_thread |
Optional |
string |
|
| omit_script |
Optional |
string |
|
| align |
Optional |
string |
|
| related |
Optional |
string |
|
| lang |
Optional |
string |
|
| checkHeader |
Optional |
boolean |
false |
| timeout |
Optional |
string |
[runtime expression] |
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Returns information allowing the creation of an embedded representation of a Tweet on third party sites. See the oEmbed specification (http://oembed.com/) for information about the response format. While this endpoint allows a bit of customization for the final appearance of the embedded Tweet, be aware that the appearance of the rendered Tweet may change over time to be consistent with Twitter's Display Guidelines. Do not rely on any class or id parameters to stay constant in the returned markup. |
| Description: |
|
|
|
| GETOUTGOINGFRIENDSHIPS |
| Application Scope - function getOutgoingFriendships |
|---|
Arguments:
| Name |
Required |
Type |
Default |
| cursor |
Optional |
string |
|
| stringify_ids |
Optional |
boolean |
false |
| checkHeader |
Optional |
boolean |
false |
| timeout |
Optional |
string |
[runtime expression] |
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Returns an array of numeric IDs for every protected user for whom the authenticating user has a pending follow request. |
| Description: |
|
|
|
| GETPARSERESULTS |
| Application Scope - function getParseResults |
|---|
| Arguments: | none |
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
I get the parseResult boolean value |
| Description: |
|
|
|
| GETPRIVACYPOLICY |
| Application Scope - function getPrivacyPolicy |
|---|
Arguments:
| Name |
Required |
Type |
Default |
| timeout |
Optional |
string |
[runtime expression] |
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Returns Twitter's Privacy Policy in the requested format. |
| Description: |
|
|
|
| GETRETWEETERIDS |
| Application Scope - function getRetweeterIDs |
|---|
Arguments:
| Name |
Required |
Type |
Default |
| id |
Required |
string |
|
| cursor |
Optional |
string |
-1 |
| stringify_ids |
Optional |
boolean |
false |
| checkHeader |
Optional |
boolean |
false |
| timeout |
Optional |
string |
[runtime expression] |
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Returns a collection of up to 100 user IDs belonging to users who have retweeted the tweet specified by the id parameter. This method offers similar data to GET statuses/retweets/:id and replaces API v1's GET statuses/:id/retweeted_by/ids method. |
| Description: |
|
|
|
| GETRETWEETS |
| Application Scope - function getRetweets |
|---|
Arguments:
| Name |
Required |
Type |
Default |
| id |
Required |
string |
|
| count |
Optional |
Numeric |
100 |
| trim_user |
Optional |
Boolean |
false |
| checkHeader |
Optional |
boolean |
false |
| timeout |
Optional |
string |
[runtime expression] |
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Returns up to 100 of the first retweets of a given tweet. |
| Description: |
|
|
|
| GETRETWEETSOFME |
| Application Scope - function getRetweetsOfMe |
|---|
Arguments:
| Name |
Required |
Type |
Default |
| count |
Optional |
string |
[empty string] |
| since_id |
Optional |
string |
[empty string] |
| max_id |
Optional |
string |
[empty string] |
| trim_user |
Optional |
string |
[empty string] |
| exclude_replies |
Optional |
string |
[empty string] |
| contributor_details |
Optional |
string |
[empty string] |
| include_entities |
Optional |
string |
[empty string] |
| include_user_entities |
Optional |
string |
[empty string] |
| checkHeader |
Optional |
boolean |
false |
| timeout |
Optional |
string |
[runtime expression] |
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Returns the most recent tweets authored by the authenticating user that have been retweeted by others. This timeline is a subset of the user's GET statuses/user_timeline. |
| Description: |
|
|
|
| GETSAVEDSEARCHES |
| Application Scope - function getSavedSearches |
|---|
Arguments:
| Name |
Required |
Type |
Default |
| checkHeader |
Optional |
boolean |
false |
| timeout |
Optional |
string |
[runtime expression] |
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Returns the authenticated user's saved search queries. |
| Description: |
|
|
|
| GETSEARCHBYID |
| Application Scope - function getSearchByID |
|---|
Arguments:
| Name |
Required |
Type |
Default |
| id |
Required |
string |
|
| checkHeader |
Optional |
boolean |
false |
| timeout |
Optional |
string |
[runtime expression] |
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Retrieve the information for the saved search represented by the given id. The authenticating user must be the owner of saved search ID being requested. |
| Description: |
|
|
|
| GETSEARCHURL |
| Application Scope - function getsearchURL |
|---|
| Arguments: | none |
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
I return the search url for use in the method calls. |
| Description: |
|
|
|
| GETSTATUSBYID |
| Application Scope - function getStatusByID |
|---|
Arguments:
| Name |
Required |
Type |
Default |
| id |
Required |
String |
|
| trim_user |
Optional |
Boolean |
false |
| include_my_retweet |
Optional |
Boolean |
false |
| include_entities |
Optional |
Boolean |
false |
| checkHeader |
Optional |
boolean |
false |
| timeout |
Optional |
string |
[runtime expression] |
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Returns a single status, specified by the id parameter below. The status's author will be returned inline. |
| Description: |
|
|
|
| GETSTATUSLOOKUP |
| Application Scope - function getStatusLookup |
|---|
Arguments:
| Name |
Required |
Type |
Default |
| id |
Required |
string |
|
| include_entities |
Optional |
string |
[empty string] |
| trim_user |
Optional |
string |
[empty string] |
| map |
Optional |
string |
[empty string] |
| checkHeader |
Optional |
boolean |
false |
| timeout |
Optional |
string |
[runtime expression] |
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Returns fully-hydrated tweet objects for up to 100 tweets per request, as specified by comma-separated values passed to the id parameter. This method is especially useful to get the details (hydrate) a collection of Tweet IDs. GET statuses/show/:id is used to retrieve a single tweet object. |
| Description: |
|
|
|
| GETTIMEOUT |
| Application Scope - function getTimeout |
|---|
| Arguments: | none |
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
I get the timeout value |
| Description: |
|
|
|
| GETUPLOADURL |
| Application Scope - function getuploadURL |
|---|
| Arguments: | none |
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
I return the upload url for use in the method calls. |
| Description: |
|
|
|
| GETUSERCONTRIBUTEES |
| Application Scope - function getUserContributees |
|---|
Arguments:
| Name |
Required |
Type |
Default |
| user_id |
Optional |
string |
|
| screen_name |
Optional |
string |
|
| include_entities |
Optional |
Boolean |
false |
| skip_status |
Optional |
string |
[empty string] |
| checkHeader |
Optional |
boolean |
false |
| timeout |
Optional |
string |
[runtime expression] |
|
| ReturnType: |
any
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Returns an array of users that the specified user can contribute to. |
| Description: |
|
|
|
| GETUSERCONTRIBUTERS |
| Application Scope - function getUserContributers |
|---|
Arguments:
| Name |
Required |
Type |
Default |
| user_id |
Optional |
string |
|
| screen_name |
Optional |
string |
|
| include_entities |
Optional |
Boolean |
false |
| skip_status |
Optional |
string |
[empty string] |
| checkHeader |
Optional |
boolean |
false |
| timeout |
Optional |
string |
[runtime expression] |
|
| ReturnType: |
any
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Returns an array of users who can contribute to the specified account. |
| Description: |
|
|
|
| GETUSERDETAILS |
| Application Scope - function getUserDetails |
|---|
Arguments:
| Name |
Required |
Type |
Default |
| user_id |
Optional |
string |
|
| screen_name |
Optional |
string |
|
| include_entities |
Optional |
Boolean |
false |
| checkHeader |
Optional |
boolean |
false |
| timeout |
Optional |
string |
[runtime expression] |
|
| ReturnType: |
any
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
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. |
| Description: |
|
|
|
| GETUSERSUGGESTIONS |
| Application Scope - function getUserSuggestions |
|---|
Arguments:
| Name |
Required |
Type |
Default |
| lang |
Optional |
String |
en |
| checkHeader |
Optional |
boolean |
false |
| timeout |
Optional |
string |
[runtime expression] |
|
| ReturnType: |
any
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Access to Twitter's suggested user list. This returns the list of suggested user categories. The category can be used in GET users/suggestions/:slug to get the users in that category. |
| Description: |
|
|
|
| GETUSERSUGGESTIONSINCATEGORY |
| Application Scope - function getUserSuggestionsInCategory |
|---|
Arguments:
| Name |
Required |
Type |
Default |
| slug |
Required |
String |
|
| lang |
Optional |
String |
en |
| checkHeader |
Optional |
boolean |
false |
| timeout |
Optional |
string |
[runtime expression] |
|
| ReturnType: |
any
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Access the users in a given category of the Twitter suggested user list. It is recommended that end clients cache this data for no more than one hour. |
| Description: |
|
|
|
| GETUSERSUGGESTIONSINCATEGORYWITHSTATUS |
| Application Scope - function getUserSuggestionsInCategoryWithStatus |
|---|
Arguments:
| Name |
Required |
Type |
Default |
| slug |
Required |
String |
|
| checkHeader |
Optional |
boolean |
false |
| timeout |
Optional |
string |
[runtime expression] |
|
| ReturnType: |
any
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Access the users in a given category of the Twitter suggested user list and return their most recent status if they are not a protected user. |
| Description: |
|
|
|
| GETUSERTIMELINE |
| Application Scope - function getUserTimeline |
|---|
Arguments:
| Name |
Required |
Type |
Default |
| user_id |
Optional |
string |
[empty string] |
| screen_name |
Optional |
string |
[empty string] |
| since_id |
Optional |
string |
[empty string] |
| count |
Optional |
string |
[empty string] |
| max_id |
Optional |
string |
[empty string] |
| trim_user |
Optional |
string |
[empty string] |
| exclude_replies |
Optional |
string |
[empty string] |
| contributor_details |
Optional |
string |
[empty string] |
| include_rts |
Optional |
string |
[empty string] |
| checkHeader |
Optional |
boolean |
false |
| timeout |
Optional |
string |
[runtime expression] |
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Returns the 20 most recent statuses posted from the authenticating user. It's also possible to request another user's timeline via the id parameter. This is the equivalent of the Web / page for your own user, or the profile page for a third party. |
| Description: |
|
|
|
| HANDLERETURNFORMAT |
| Application Scope - function handleReturnFormat |
|---|
Arguments:
| Name |
Required |
Type |
Default |
| data |
Required |
string |
|
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
I handle how the data is returned based upon the provided format |
| Description: |
|
|
|
| HOVERCARDS |
| Application Scope - function hovercards |
|---|
Arguments:
| Name |
Required |
Type |
Default |
| htmlSection |
Optional |
string |
[empty string] |
| linkify |
Optional |
boolean |
true |
| infer |
Optional |
boolean |
false |
| expanded |
Optional |
boolean |
false |
| individual |
Optional |
boolean |
true |
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Hovercard is a small, context-aware tooltip that provides access to data about a particular Twitter user. Hovercards also allows a user to take action upon a Twitter user such as following and unfollowing, as well as toggling device updates. |
| Description: |
|
|
|
| INIT |
| Application Scope - function init |
|---|
Arguments:
| Name |
Required |
Type |
Default |
| consumerKey |
Required |
string |
[empty string] |
| consumerSecret |
Required |
string |
[empty string] |
| oauthToken |
Optional |
string |
[empty string] |
| oauthTokenSecret |
Optional |
string |
[empty string] |
| userAccountName |
Optional |
string |
[empty string] |
| parseResults |
Optional |
boolean |
false |
| timeout |
Optional |
string |
30 |
|
| ReturnType: |
any
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
I am the constructor method for the monkehTweet object. |
| Description: |
|
|
|
| LANGUAGES |
| Application Scope - function languages |
|---|
Arguments:
| Name |
Required |
Type |
Default |
| timeout |
Optional |
string |
[runtime expression] |
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Returns the list of languages supported by Twitter along with their ISO 639-1 code. The ISO 639-1 code is the two letter value to use if you include lang with any of your requests. |
| Description: |
|
|
|
| LINKIFYUSERS |
| Application Scope - function linkifyUsers |
|---|
Arguments:
| Name |
Required |
Type |
Default |
| htmlSection |
Optional |
string |
[empty string] |
| className |
Optional |
string |
[empty string] |
| individual |
Optional |
boolean |
true |
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| LOGIN |
| Application Scope - function login |
|---|
Arguments:
| Name |
Required |
Type |
Default |
| htmlSection |
Required |
string |
|
| size |
Optional |
string |
medium |
| authComplete |
Optional |
string |
[empty string] |
| signOut |
Optional |
string |
[empty string] |
| custom |
Optional |
boolean |
false |
| individual |
Optional |
boolean |
true |
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
The 'Connect with Twitter' button provides a method for users to authenticate securely with Twitter, yielding your application with an access token for use in API calls. |
| Description: |
|
|
|
| LOOKUPUSER |
| Application Scope - function lookupUser |
|---|
Arguments:
| Name |
Required |
Type |
Default |
| user_id |
Optional |
string |
|
| screen_name |
Optional |
string |
|
| include_entities |
Optional |
Boolean |
false |
| checkHeader |
Optional |
boolean |
false |
| timeout |
Optional |
string |
[runtime expression] |
|
| ReturnType: |
any
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
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. |
| Description: |
|
|
|
| MAKEGETCALL |
| Application Scope - function makeGetCall |
|---|
Arguments:
| Name |
Required |
Type |
Default |
| URLEndpoint |
Required |
string |
|
| timeout |
Optional |
string |
[runtime expression] |
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
package |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
I am the function that makes the cfhttp GET requests |
| Description: |
|
|
|
| MAKERESOURCEREQUEST |
| Application Scope - function makeResourceRequest |
|---|
Arguments:
| Name |
Required |
Type |
Default |
| accessToken |
Required |
string |
|
| accessSecret |
Required |
string |
|
| httpurl |
Required |
string |
|
| httpmethod |
Required |
string |
|
| parameters |
Optional |
struct |
|
| timeout |
Optional |
string |
[runtime expression] |
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Gets an Access Token which can be stored and used for future access |
| Description: |
|
|
|
| MATCHCOUNT |
| Application Scope - function matchCount |
|---|
Arguments:
| Name |
Required |
Type |
Default |
| count |
Optional |
string |
200 |
|
| ReturnType: |
Array
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
I run a regex match on the count parameter |
| Description: |
|
|
|
| PARSETWITTERDATEFORMAT |
| Application Scope - function parseTwitterDateFormat |
|---|
Arguments:
| Name |
Required |
Type |
Default |
| twitterDate |
Required |
string |
|
|
| ReturnType: |
String
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
I return a date in a useable date format. |
| Description: |
|
|
|
| POSTUPDATE |
| Application Scope - function postUpdate |
|---|
Arguments:
| Name |
Required |
Type |
Default |
| status |
Required |
String |
|
| in_reply_to_status_id |
Optional |
String |
|
| lat |
Optional |
String |
|
| long |
Optional |
String |
|
| place_id |
Optional |
String |
|
| display_coordinates |
Optional |
String |
|
| trim_user |
Optional |
Boolean |
false |
| checkHeader |
Optional |
boolean |
false |
| timeout |
Optional |
string |
[runtime expression] |
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Updates the authenticating user's status. Request must be a POST. A status update with text identical to the authenticating user's current status will be ignored to prevent duplicates. |
| Description: |
|
|
|
| POSTUPDATEWITHMEDIA |
| Application Scope - function postUpdateWithMedia |
|---|
Arguments:
| Name |
Required |
Type |
Default |
| status |
Required |
String |
|
| media |
Required |
string |
|
| possibly_sensitive |
Optional |
boolean |
false |
| in_reply_to_status_id |
Optional |
String |
|
| lat |
Optional |
String |
|
| long |
Optional |
String |
|
| place_id |
Optional |
String |
|
| display_coordinates |
Optional |
String |
|
| checkHeader |
Optional |
boolean |
false |
| timeout |
Optional |
string |
[runtime expression] |
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Updates the authenticating user's status. Request must be a POST. A status update with text identical to the authenticating user's current status will be ignored to prevent duplicates. |
| Description: |
|
|
|
| REMOVEFROMFAVORITES |
| Application Scope - function removeFromFavorites |
|---|
Arguments:
| Name |
Required |
Type |
Default |
| id |
Required |
string |
|
| include_entities |
Optional |
Boolean |
false |
| checkHeader |
Optional |
boolean |
false |
| timeout |
Optional |
string |
[runtime expression] |
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Un-favorites the status specified in the ID parameter as the authenticating user. Returns the un-favorited status in the requested format when successful. |
| Description: |
|
|
|
| REPORTSPAM |
| Application Scope - function reportSpam |
|---|
Arguments:
| Name |
Required |
Type |
Default |
| user_id |
Optional |
string |
|
| screen_name |
Optional |
string |
|
| checkHeader |
Optional |
boolean |
false |
| timeout |
Optional |
string |
[runtime expression] |
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
The user specified in the id is blocked by the authenticated user and reported as a spammer. |
| Description: |
|
|
|
| RETWEET |
| Application Scope - function retweet |
|---|
Arguments:
| Name |
Required |
Type |
Default |
| id |
Required |
string |
|
| trim_user |
Optional |
Boolean |
false |
| checkHeader |
Optional |
boolean |
false |
| timeout |
Optional |
string |
[runtime expression] |
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Retweets a tweet. Requires the id parameter of the tweet you are retweeting. Returns the original tweet with retweet details embedded. |
| Description: |
|
|
|
| SAVETHISSEARCH |
| Application Scope - function saveThisSearch |
|---|
Arguments:
| Name |
Required |
Type |
Default |
| query |
Required |
string |
|
| checkHeader |
Optional |
boolean |
false |
| timeout |
Optional |
string |
[runtime expression] |
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Create a new saved search for the authenticated user. A user may only have 25 saved searches. |
| Description: |
|
|
|
| SEARCH |
| Application Scope - function search |
|---|
Arguments:
| Name |
Required |
Type |
Default |
| q |
Required |
String |
|
| geocode |
Optional |
String |
|
| lang |
Optional |
String |
|
| locale |
Optional |
String |
|
| result_type |
Optional |
String |
mixed |
| count |
Optional |
String |
|
| until |
Optional |
String |
|
| since_id |
Optional |
String |
|
| max_id |
Optional |
string |
[empty string] |
| include_entities |
Optional |
String |
true |
| checkHeader |
Optional |
boolean |
false |
| timeout |
Optional |
string |
[runtime expression] |
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Returns tweets that match a specified query. |
| Description: |
|
|
|
| SEARCHFORUSER |
| Application Scope - function searchForUser |
|---|
Arguments:
| Name |
Required |
Type |
Default |
| q |
Required |
string |
|
| page |
Optional |
string |
1 |
| count |
Optional |
string |
20 |
| include_entities |
Optional |
Boolean |
false |
| checkHeader |
Optional |
boolean |
false |
| timeout |
Optional |
string |
[runtime expression] |
|
| ReturnType: |
any
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Runs a search for users similar to Find People button on Twitter.com. The results returned by people search on Twitter.com are the same as those returned by this API request. Note that unlike GET search, this method does not support any operators. Only the first 1000 matches are available. |
| Description: |
|
|
|
| SETFINALACCESSDETAILS |
| Application Scope - function setFinalAccessDetails |
|---|
Arguments:
| Name |
Required |
Type |
Default |
| oauthToken |
Required |
string |
|
| oauthTokenSecret |
Required |
string |
|
| userAccountName |
Required |
string |
|
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
I set the value of the oauthToken, oauthTokenSecret and authenticated user's screenname after a successful authentication. |
| Description: |
|
|
|
| SETOAUTHCONSUMER |
| Application Scope - function setOAuthConsumer |
|---|
Arguments:
| Name |
Required |
Type |
Default |
| consumerKey |
Required |
string |
[empty string] |
| consumerSecret |
Required |
string |
[empty string] |
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
I set the values for the consumerKey and consumerSecret. |
| Description: |
|
|
|
| SHOWFRIENDSHIPS |
| Application Scope - function showFriendships |
|---|
Arguments:
| Name |
Required |
Type |
Default |
| source_id |
Optional |
string |
|
| source_screen_name |
Optional |
string |
|
| target_id |
Optional |
string |
|
| target_screen_name |
Optional |
string |
|
| checkHeader |
Optional |
boolean |
false |
| timeout |
Optional |
string |
[runtime expression] |
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Returns detailed information about the relationship between two users. |
| Description: |
|
|
|
| SHOWLISTSUBSCRIBER |
| Application Scope - function showListSubscriber |
|---|
Arguments:
| Name |
Required |
Type |
Default |
| owner_screen_name |
Optional |
string |
[empty string] |
| owner_id |
Optional |
string |
[empty string] |
| list_id |
Required |
string |
[empty string] |
| slug |
Optional |
String |
[empty string] |
| user_id |
Optional |
String |
[empty string] |
| screen_name |
Optional |
String |
[empty string] |
| include_entities |
Optional |
Boolean |
|
| skip_status |
Optional |
string |
[empty string] |
| checkHeader |
Optional |
boolean |
false |
| timeout |
Optional |
string |
[runtime expression] |
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Check if the specified user is a subscriber of the specified list. Returns the user if they are subscriber. |
| Description: |
|
|
|
| TRENDBYLOCATION |
| Application Scope - function trendByLocation |
|---|
Arguments:
| Name |
Required |
Type |
Default |
| woeid |
Required |
string |
|
| exclude |
Optional |
string |
|
| checkHeader |
Optional |
boolean |
false |
| timeout |
Optional |
string |
[runtime expression] |
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
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. |
| Description: |
|
|
|
| TWEETBOX |
| Application Scope - function tweetBox |
|---|
Arguments:
| Name |
Required |
Type |
Default |
| htmlSection |
Required |
string |
|
| counter |
Required |
boolean |
true |
| height |
Optional |
numeric |
65 |
| width |
Optional |
numeric |
515 |
| label |
Optional |
string |
What's happening? |
| defaultContent |
Optional |
string |
[empty string] |
| onTweet |
Optional |
string |
[empty string] |
| data |
Optional |
struct |
[runtime expression] |
| individual |
Optional |
boolean |
true |
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
The Tweet Box allows Twitter users to tweet directly from within your web site or web application. |
| Description: |
|
|
|
| TWITANYWHERE |
| Application Scope - function twitAnywhere |
|---|
Arguments:
| Name |
Required |
Type |
Default |
| params |
Required |
struct |
|
| includHeaderScript |
Optional |
boolean |
true |
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
I build the JS script block and populate the required calls to the @Anywhere service. |
| Description: |
|
|
|
| UNBLOCKUSER |
| Application Scope - function unblockUser |
|---|
Arguments:
| Name |
Required |
Type |
Default |
| user_id |
Optional |
string |
|
| screen_name |
Optional |
string |
|
| include_entities |
Optional |
Boolean |
|
| skip_status |
Optional |
string |
[empty string] |
| checkHeader |
Optional |
boolean |
false |
| timeout |
Optional |
string |
[runtime expression] |
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Un-blocks the user specified in the ID parameter for the authenticating user. Returns the un-blocked user in the requested format when successful. |
| Description: |
|
|
|
| UNFOLLOWUSER |
| Application Scope - function unfollowUser |
|---|
Arguments:
| Name |
Required |
Type |
Default |
| user_id |
Optional |
string |
|
| screen_name |
Optional |
string |
|
| include_entities |
Optional |
Boolean |
false |
| checkHeader |
Optional |
boolean |
false |
| timeout |
Optional |
string |
[runtime expression] |
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Allows the authenticating users to unfollow the user specified in the ID parameter. Returns the unfollowed user in the requested format when successful. Returns a string describing the failure condition when unsuccessful. |
| Description: |
|
|
|
| UPDATEACCOUNTSETTINGS |
| Application Scope - function updateAccountSettings |
|---|
Arguments:
| Name |
Required |
Type |
Default |
| trend_location_woeid |
Required |
string |
[empty string] |
| sleep_time_enabled |
Optional |
string |
[empty string] |
| start_sleep_time |
Optional |
string |
[empty string] |
| end_sleep_time |
Optional |
string |
[empty string] |
| time_zone |
Optional |
string |
[empty string] |
| lang |
Optional |
string |
[empty string] |
| checkHeader |
Optional |
boolean |
false |
| timeout |
Optional |
string |
[runtime expression] |
|
| ReturnType: |
any
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Updates the authenticating user's settings. |
| Description: |
|
|
|
| UPDATEFRIENDSHIPS |
| Application Scope - function updateFriendships |
|---|
Arguments:
| Name |
Required |
Type |
Default |
| user_id |
Optional |
string |
|
| screen_name |
Optional |
string |
|
| device |
Optional |
Boolean |
false |
| retweets |
Optional |
Boolean |
false |
| checkHeader |
Optional |
boolean |
false |
| timeout |
Optional |
string |
[runtime expression] |
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Allows one to enable or disable retweets and device notifications from the specified user. |
| Description: |
|
|
|
| UPDATELIST |
| Application Scope - function updateList |
|---|
Arguments:
| Name |
Required |
Type |
Default |
| list_id |
Optional |
string |
[empty string] |
| slug |
Optional |
String |
[empty string] |
| name |
Optional |
string |
[empty string] |
| mode |
Optional |
string |
public |
| description |
Optional |
string |
[empty string] |
| owner_screen_name |
Optional |
string |
[empty string] |
| owner_id |
Optional |
string |
[empty string] |
| checkHeader |
Optional |
boolean |
false |
| timeout |
Optional |
string |
[runtime expression] |
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Updates the specified list. The authenticated user must own the list to be able to update it. |
| Description: |
|
|
|
| UPDATEPROFILE |
| Application Scope - function updateProfile |
|---|
Arguments:
| Name |
Required |
Type |
Default |
| name |
Optional |
string |
|
| url |
Optional |
string |
|
| location |
Optional |
string |
|
| description |
Optional |
string |
|
| include_entities |
Optional |
Boolean |
false |
| skip_status |
Optional |
string |
[empty string] |
| checkHeader |
Optional |
boolean |
false |
| timeout |
Optional |
string |
[runtime expression] |
|
| ReturnType: |
any
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Sets values that users are able to set under the 'Account' tab of their settings page. Only the parameters specified will be updated. |
| Description: |
|
|
|
| UPDATEPROFILEBACKGROUNDIMAGE |
| Application Scope - function updateProfileBackgroundImage |
|---|
Arguments:
| Name |
Required |
Type |
Default |
| image |
Optional |
string |
[empty string] |
| tile |
Optional |
string |
[empty string] |
| include_entities |
Optional |
Boolean |
false |
| skip_status |
Optional |
string |
[empty string] |
| use |
Optional |
string |
[empty string] |
| checkHeader |
Optional |
boolean |
false |
| timeout |
Optional |
string |
[runtime expression] |
|
| ReturnType: |
any
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Updates the authenticating user's profile background image. This method can also be used to enable or disable the profile background image. Although each parameter is marked as optional, at least one of image, tile or use must be provided when making this request. |
| Description: |
|
|
|
| UPDATEPROFILECOLORS |
| Application Scope - function updateProfileColors |
|---|
Arguments:
| Name |
Required |
Type |
Default |
| profile_background_color |
Optional |
string |
[empty string] |
| profile_link_color |
Optional |
string |
[empty string] |
| profile_sidebar_border_color |
Optional |
string |
[empty string] |
| profile_sidebar_fill_color |
Optional |
string |
[empty string] |
| profile_text_color |
Optional |
string |
[empty string] |
| include_entities |
Optional |
Boolean |
false |
| skip_status |
Optional |
string |
[empty string] |
| checkHeader |
Optional |
boolean |
false |
| timeout |
Optional |
string |
[runtime expression] |
|
| ReturnType: |
any
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
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). |
| Description: |
|
|
|
| UPDATEPROFILEIMAGE |
| Application Scope - function updateProfileImage |
|---|
Arguments:
| Name |
Required |
Type |
Default |
| image |
Required |
any |
[empty string] |
| include_entities |
Optional |
Boolean |
false |
| skip_status |
Optional |
string |
[empty string] |
| checkHeader |
Optional |
boolean |
false |
| timeout |
Optional |
string |
[runtime expression] |
|
| ReturnType: |
any
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Updates the authenticating user's profile image. Note that this method expects raw multipart data, not a URL to an image. This method asynchronously processes the uploaded file before updating the user's profile image URL. You can either update your local cache the next time you request the user's information, or, at least 5 seconds after uploading the image, ask for the updated URL using GET users/profile_image/:screen_name. |
| Description: |
|
|
|
| VERIFYCREDENTIALS |
| Application Scope - function verifyCredentials |
|---|
Arguments:
| Name |
Required |
Type |
Default |
| include_entities |
Optional |
Boolean |
false |
| include_email |
Optional |
Boolean |
true |
| skip_status |
Optional |
string |
[empty string] |
| checkHeader |
Optional |
boolean |
false |
| timeout |
Optional |
string |
[runtime expression] |
|
| ReturnType: |
any
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
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. |
| Description: |
|
|
|