Next: Introduction, Previous: (dir), Up: (dir) [Contents][Index]
This is the chirp Reference Manual, version 0.2.0, generated automatically by Declt version 3.0 "Montgomery Scott" on Tue Dec 22 11:59:54 2020 GMT+0.
• Introduction | What chirp is all about | |
• Systems | The systems documentation | |
• Files | The files documentation | |
• Packages | The packages documentation | |
• Definitions | The symbols documentation | |
• Indexes | Concepts, functions, variables and data types |
Load Chirp through Quicklisp or ASDF:
(ql:quickload :chirp)
To use twitter's API, you need to authorize an account. By default this happens through the PIN method, though others are available as well. Retrieve your twitter application's api key and secret and invoke the following function:
(chirp:initiate-authentication :api-key "<app api key>" :api-secret "<app api secret>")
You may use the following keys for testing purposes: API-KEY: D1pMCK17gI10bQ6orBPS0w
API-SECRET: BfkvKNRRMoBPkEtDYAAOPW4s2G9U8Z7u3KAf0dBUA
. These are for the CL-CHIRP twitter application. You should not use these for anything other than the testing of Chirp, as it may pose a security risk.
If the first OAuth step is successful, it should return an URL that you have to visit. This will then prompt you to authorize the application and present a PIN. Copy this pin and complete the authentication process:
(chirp:complete-authentication "<pin>")
If the function returns successfully, you are ready to use the twitter API:
(chirp:account/verify-credentials)
In the case that you do not want to repeat the authentication process, you can save and later set the *oauth-api-key*
, *oauth-api-secret*
, *oauth-access-token*
and *oauth-access-secret*
variables manually. That's all the information it takes to authenticate over twitter. Make sure to keep these tokens secret.
(chirp:statuses/update "Hooray, I successfully used the Chirp Common Lisp library to tweet!")
There are functions to check for tweet length, available languages, access level, rate limits, and so on as well.
(chirp:compute-status-length "Wowsers, URL shortening sure is a thing! https://github.com/Shinmera/chirp.git")
(chirp:valid-language-p "en")
(chirp:access-level)
Chirp also provides access to twitter's streaming API:
(chirp:stream/user #'(lambda (message) (when message (format T "~&STREAM: ~a~%" message)) T))
Do note that Chirp does not concern itself with threading. As such, processing stream objects in the background is up to you.
Using the various convenience methods, a simple bot can be assembled with relative ease:
(chirp:map-timeline :mentions #'(lambda (status) (chirp:reply status "Chirp chirp!")))
Though the timelines are heavily rate-limited. For a more immediate response, the streaming API should be used:
(chirp:start-stream
:user #'(lambda (message)
(when (and (typep message 'chirp:status) (chirp:direct-mention-p message))
(chirp:reply message "Chirp chirp!"))
T))
One thing to note is that twitter XML entity encodes certain things like status texts. I frankly don't know why it does that since it's a JSON api. Chirp does not automatically decode these entities, as the twitter entities (like hashtags, urls, etc) contain position markers that depend on the encoded string. Decoding it screws over these positions. However, Chirp offers a couple of functions to make handling of entities or decoding easier:
(chirp:xml-decode (chirp:text status))
(chirp:text-with-expanded-urls status)
(chirp:text-with-markup status)
(chirp:replace-entity :urls #'expanded-url)
Especially the last two can be very useful for preparing the text for a web-interface.
Chirp's symbols are separated into three packages (and unified in CHIRP
) so that you may selectively USE
what you need.
CHIRP-API
contains all the direct Twitter API call mapping functions.CHIRP-EXTRA
contains the various helper functions that make dealing with the API easier.CHIRP-OBJECTS
contains all accessor and class symbols. You probably want to USE
this package if you work with the objects a lot.Next: Files, Previous: Introduction, Up: Top [Contents][Index]
The main system appears first, followed by any subsystem dependency.
• The chirp system | ||
• The chirp-drakma system | ||
• The chirp-core system |
Next: The chirp-drakma system, Previous: Systems, Up: Systems [Contents][Index]
Nicolas Hafner <shinmera@tymoon.eu>
Nicolas Hafner <shinmera@tymoon.eu>
(:git "https://github.com/shinmera/chirp.git")
zlib
Chirp Twitter client featuring full API coverage.
0.2.0
chirp-drakma (system)
chirp.asd (file)
Next: The chirp-core system, Previous: The chirp system, Up: Systems [Contents][Index]
Nicolas Hafner <shinmera@tymoon.eu>
Nicolas Hafner <shinmera@tymoon.eu>
zlib
Chirp Twitter client using Drakma as backend.
0.2.0
chirp-drakma.asd (file)
drakma.lisp (file)
Previous: The chirp-drakma system, Up: Systems [Contents][Index]
Nicolas Hafner <shinmera@tymoon.eu>
Nicolas Hafner <shinmera@tymoon.eu>
zlib
Core component of the chirp twitter client, excluding the backend.
0.2.0
chirp-core.asd (file)
Files are sorted by type and then listed depth-first from the systems components trees.
• Lisp files |
Next: The chirp-drakma․asd file, Previous: Lisp files, Up: Lisp files [Contents][Index]
chirp.asd
chirp (system)
Next: The chirp-core․asd file, Previous: The chirp․asd file, Up: Lisp files [Contents][Index]
chirp-drakma.asd
chirp-drakma (system)
Next: The chirp-drakma/drakma․lisp file, Previous: The chirp-drakma․asd file, Up: Lisp files [Contents][Index]
chirp-core.asd
chirp-core (system)
Next: The chirp-core/package․lisp file, Previous: The chirp-core․asd file, Up: Lisp files [Contents][Index]
chirp-drakma (system)
drakma.lisp
Next: The chirp-core/indent․lisp file, Previous: The chirp-drakma/drakma․lisp file, Up: Lisp files [Contents][Index]
chirp-core (system)
package.lisp
Next: The chirp-core/toolkit․lisp file, Previous: The chirp-core/package․lisp file, Up: Lisp files [Contents][Index]
package.lisp (file)
chirp-core (system)
indent.lisp
Next: The chirp-core/oauth․lisp file, Previous: The chirp-core/indent․lisp file, Up: Lisp files [Contents][Index]
indent.lisp (file)
chirp-core (system)
toolkit.lisp
Next: The chirp-core/location․lisp file, Previous: The chirp-core/toolkit․lisp file, Up: Lisp files [Contents][Index]
toolkit.lisp (file)
chirp-core (system)
oauth.lisp
Next: The chirp-core/trends․lisp file, Previous: The chirp-core/oauth․lisp file, Up: Lisp files [Contents][Index]
oauth.lisp (file)
chirp-core (system)
location.lisp
Next: The chirp-core/entities․lisp file, Previous: The chirp-core/location․lisp file, Up: Lisp files [Contents][Index]
location.lisp (file)
chirp-core (system)
trends.lisp
Next: The chirp-core/help․lisp file, Previous: The chirp-core/trends․lisp file, Up: Lisp files [Contents][Index]
trends.lisp (file)
chirp-core (system)
entities.lisp
Next: The chirp-core/cursor․lisp file, Previous: The chirp-core/entities․lisp file, Up: Lisp files [Contents][Index]
entities.lisp (file)
chirp-core (system)
help.lisp
Next: The chirp-core/user․lisp file, Previous: The chirp-core/help․lisp file, Up: Lisp files [Contents][Index]
help.lisp (file)
chirp-core (system)
cursor.lisp
Next: The chirp-core/account․lisp file, Previous: The chirp-core/cursor․lisp file, Up: Lisp files [Contents][Index]
cursor.lisp (file)
chirp-core (system)
user.lisp
Next: The chirp-core/blocks․lisp file, Previous: The chirp-core/user․lisp file, Up: Lisp files [Contents][Index]
user.lisp (file)
chirp-core (system)
account.lisp
Next: The chirp-core/suggestions․lisp file, Previous: The chirp-core/account․lisp file, Up: Lisp files [Contents][Index]
account.lisp (file)
chirp-core (system)
blocks.lisp
Next: The chirp-core/statuses․lisp file, Previous: The chirp-core/blocks․lisp file, Up: Lisp files [Contents][Index]
blocks.lisp (file)
chirp-core (system)
suggestions.lisp
Next: The chirp-core/timelines․lisp file, Previous: The chirp-core/suggestions․lisp file, Up: Lisp files [Contents][Index]
suggestions.lisp (file)
chirp-core (system)
statuses.lisp
Next: The chirp-core/direct-messages․lisp file, Previous: The chirp-core/statuses․lisp file, Up: Lisp files [Contents][Index]
statuses.lisp (file)
chirp-core (system)
timelines.lisp
Next: The chirp-core/friends․lisp file, Previous: The chirp-core/timelines․lisp file, Up: Lisp files [Contents][Index]
timelines.lisp (file)
chirp-core (system)
direct-messages.lisp
Next: The chirp-core/favorites․lisp file, Previous: The chirp-core/direct-messages․lisp file, Up: Lisp files [Contents][Index]
direct-messages.lisp (file)
chirp-core (system)
friends.lisp
Next: The chirp-core/saved-searches․lisp file, Previous: The chirp-core/friends․lisp file, Up: Lisp files [Contents][Index]
friends.lisp (file)
chirp-core (system)
favorites.lisp
Next: The chirp-core/search․lisp file, Previous: The chirp-core/favorites․lisp file, Up: Lisp files [Contents][Index]
favorites.lisp (file)
chirp-core (system)
saved-searches.lisp
Next: The chirp-core/lists․lisp file, Previous: The chirp-core/saved-searches․lisp file, Up: Lisp files [Contents][Index]
saved-searches.lisp (file)
chirp-core (system)
search.lisp
Next: The chirp-core/stream․lisp file, Previous: The chirp-core/search․lisp file, Up: Lisp files [Contents][Index]
search.lisp (file)
chirp-core (system)
lists.lisp
Next: The chirp-core/generics․lisp file, Previous: The chirp-core/lists․lisp file, Up: Lisp files [Contents][Index]
lists.lisp (file)
chirp-core (system)
stream.lisp
Next: The chirp-core/collections․lisp file, Previous: The chirp-core/stream․lisp file, Up: Lisp files [Contents][Index]
stream.lisp (file)
chirp-core (system)
generics.lisp
%map-timeline (function)
Previous: The chirp-core/generics․lisp file, Up: Lisp files [Contents][Index]
generics.lisp (file)
chirp-core (system)
collections.lisp
Next: Definitions, Previous: Files, Up: Top [Contents][Index]
Packages are listed by definition order.
• The chirp package | ||
• The chirp-api package | ||
• The chirp-objects package | ||
• The chirp-extra package |
Next: The chirp-api package, Previous: Packages, Up: Packages [Contents][Index]
package.lisp (file)
org.tymoonnext.chirp
Next: The chirp-objects package, Previous: The chirp package, Up: Packages [Contents][Index]
package.lisp (file)
org.tymoonnext.chirp.api
Next: The chirp-extra package, Previous: The chirp-api package, Up: Packages [Contents][Index]
package.lisp (file)
org.tymoonnext.chirp.objects
Previous: The chirp-objects package, Up: Packages [Contents][Index]
package.lisp (file)
org.tymoonnext.chirp.extra
Definitions are sorted by export status, category, package, and then by lexicographic order.
• Exported definitions | ||
• Internal definitions |
Next: Internal definitions, Previous: Definitions, Up: Definitions [Contents][Index]
• Exported special variables | ||
• Exported macros | ||
• Exported functions | ||
• Exported generic functions | ||
• Exported conditions | ||
• Exported classes |
Next: Exported macros, Previous: Exported definitions, Up: Exported definitions [Contents][Index]
oauth.lisp (file)
oauth.lisp (file)
help.lisp (file)
help.lisp (file)
account.lisp (file)
Possible values for the connections field in a relationship object.
friends.lisp (file)
oauth.lisp (file)
oauth.lisp (file)
oauth.lisp (file)
oauth.lisp (file)
oauth.lisp (file)
oauth.lisp (file)
oauth.lisp (file)
Next: Exported functions, Previous: Exported special variables, Up: Exported definitions [Contents][Index]
Iterates over all data sets of a cursor, binding the request data to DATA-VAR on each iteration. Returns the cursor at its end position.
cursor.lisp (file)
Creates a PREPARE statement out of the provided variables.
toolkit.lisp (file)
Shorthand macro for replacing multiple entities.
STATUS — A status object or any object with entities, or a list of entities.
ENTITYVAR — The variable to use in the replacement functions.
TEXT — The text to pass to REPLACE-ENTITIES
REPLACEMENTS ::= (TYPE FORM*)*
TYPE — An entity type. Should be one of :USER-MENTIONS :URLS :SYMBOLS :HASHTAGS :MEDIA.
statuses.lisp (file)
Next: Exported generic functions, Previous: Exported macros, Up: Exported definitions [Contents][Index]
Returns :READ, :READ-WRITE, :READ-WRITE-DIRECTMESSAGES or NIL indicating the current access level.
oauth.lisp (file)
Removes the uploaded profile banner for the authenticating user. Returns T on success.
According to spec https://dev.twitter.com/docs/api/1.1/post/account/remove_profile_banner
account.lisp (file)
Alias for ACCOUNT/VERIFY-CREDENTIALS, using caching.
account.lisp (file)
Returns settings (including current trend, geo and sleep time information) for the authenticating user.
According to spec https://dev.twitter.com/docs/api/1.1/get/account/settings
account.lisp (file)
Sets values that users are able to set under the "Account" tab of their settings page. Only the parameters specified will be updated.
According to spec https://dev.twitter.com/docs/api/1.1/post/account/update_profile
account.lisp (file)
Updates the authenticating user’s profile background image. This method can also be used to enable or disable the profile background image.
According to spec https://dev.twitter.com/docs/api/1.1/post/account/update_profile_background_image
account.lisp (file)
Uploads a profile banner on behalf of the authenticating user. For best results, upload an <3MB image that is exactly 1252px by 626px. Returns T on success.
According to spec https://dev.twitter.com/docs/api/1.1/post/account/update_profile_banner
account.lisp (file)
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).
According to spec https://dev.twitter.com/docs/api/1.1/post/account/update_profile_colors
account.lisp (file)
Updates the authenticating user’s profile image. Note that this method expects raw multipart data, not a URL to an image.
According to spec https://dev.twitter.com/docs/api/1.1/post/account/update_profile_image
account.lisp (file)
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.
According to spec https://dev.twitter.com/docs/api/1.1/get/account/verify_credentials
account.lisp (file)
Returns the current rate limits for methods belonging to the specified resource families.
According to spec https://dev.twitter.com/docs/api/1.1/get/application/rate_limit_status
Blocks the specified user from following the authenticating user. In addition the blocked user will not show in the authenticating users mentions or timeline (unless retweeted by another user). If a follow or friend relationship exists it is destroyed.
According to spec https://dev.twitter.com/docs/api/1.1/post/blocks/create
blocks.lisp (file)
Un-blocks the user specified in the ID parameter for the authenticating user. Returns the un-blocked user in the requested format when successful. If relationships existed before the block was instated, they will not be restored.
According to spec https://dev.twitter.com/docs/api/1.1/post/blocks/destroy
blocks.lisp (file)
Returns a list of numeric user ids the authenticating user is blocking.
According to spec https://dev.twitter.com/docs/api/1.1/get/blocks/ids
blocks.lisp (file)
Returns a list of user objects that the authenticating user is blocking.
According to spec https://dev.twitter.com/docs/api/1.1/get/blocks/list
blocks.lisp (file)
https://developer.twitter.com/en/docs/tweets/curate-a-collection/api-reference/post-collections-entries-add
collections.lisp (file)
https://developer.twitter.com/en/docs/tweets/curate-a-collection/api-reference/post-collections-create
timeline-order:
curation_reverse_chron : order added (default)
tweet_chron : oldest first
tweet_reverse_chron : most recent first
collections.lisp (file)
Curate tweets with alist that consisted of operations and tweet-id.
Example:
(defparameter *col* (collection/show "custom-123456789"))
(collections/curate *col*
’((:add 1234)
(:add 4321)
(:remove 1111)
(:add 2222)))
; => DONE
According to spec https://developer.twitter.com/en/docs/tweets/curate-a-collection/api-reference/post-collections-entries-curate
collections.lisp (file)
https://developer.twitter.com/en/docs/tweets/curate-a-collection/api-reference/post-collections-destroy
collections.lisp (file)
https://developer.twitter.com/en/docs/tweets/curate-a-collection/api-reference/get-collections-entries
collections.lisp (file)
https://developer.twitter.com/en/docs/tweets/curate-a-collection/api-reference/get-collections-list
collections.lisp (file)
https://developer.twitter.com/en/docs/tweets/curate-a-collection/api-reference/post-collections-entries-move
collections.lisp (file)
https://developer.twitter.com/en/docs/tweets/curate-a-collection/api-reference/post-collections-entries-remove
collections.lisp (file)
https://developer.twitter.com/en/docs/tweets/curate-a-collection/api-reference/get-collections-show
collections.lisp (file)
https://developer.twitter.com/en/docs/tweets/curate-a-collection/api-reference/post-collections-update
collections.lisp (file)
Finishes the authentication procedure by retrieving the access token. Sets the *OAUTH-TOKEN* and *OAUTH-TOKEN-SECRET* to their respective values.
oauth.lisp (file)
Computes the final status length by shortening the URLs within the tweet according to twitter’s current URL shortening configurations. If the configuration has not been fetched before, this function call will result in an api call.
statuses.lisp (file)
Collects the given parameter into one list by APPEND.
cursor.lisp (file)
Performs a signed-request returning a cursor instance tailored for it.
cursor.lisp (file)
Returns T if the status is a direct mention of the currently identified user.
To qualify as a direct mention, the mention has to appear before any other text in the tweet.
statuses.lisp (file)
Returns the 20 most recent direct messages sent to the authenticating user. Includes detailed information about the sender and recipient user. You can request up to 200 direct messages per call, up to a maximum of 800 incoming DMs.
According to spec https://dev.twitter.com/docs/api/1.1/get/direct_messages
direct-messages.lisp (file)
Destroys the direct message specified in the required ID parameter. The authenticating user must be the recipient of the specified direct message.
According to spec https://dev.twitter.com/docs/api/1.1/post/direct_messages/destroy
direct-messages.lisp (file)
Sends a new direct message to the specified user from the authenticating user. Requires both the user and text parameters and must be a POST. Returns the sent message in the requested format if successful.
According to spec https://dev.twitter.com/docs/api/1.1/post/direct_messages/new
direct-messages.lisp (file)
Returns the 20 most recent direct messages sent by the authenticating user. Includes detailed information about the sender and recipient user. You can request up to 200 direct messages per call, up to a maximum of 800 outgoing DMs.
According to spec https://dev.twitter.com/docs/api/1.1/get/direct_messages/sent
direct-messages.lisp (file)
Returns a single direct message, specified by an id parameter. Like the direct-messages request, this method will include the user objects of the sender and recipient.
According to spec https://dev.twitter.com/docs/api/1.1/get/direct_messages/show
direct-messages.lisp (file)
Favorites the status specified in the ID parameter as the authenticating user. Returns the favorite status when successful.
According to spec https://dev.twitter.com/docs/api/1.1/post/favorites/create
favorites.lisp (file)
Un-favorites the status specified in the ID parameter as the authenticating user. Returns the un-favorited status in the requested format when successful.
According to spec https://dev.twitter.com/docs/api/1.1/post/favorites/destroy
favorites.lisp (file)
Returns the 20 most recent Tweets favorited by the authenticating or specified user.
According to spec https://dev.twitter.com/docs/api/1.1/get/favorites/list
favorites.lisp (file)
toolkit.lisp (file)
Returns a list of user IDs for every user following the specified user.
According to spec https://dev.twitter.com/docs/api/1.1/get/followers/ids
friends.lisp (file)
Returns a list of user objects for users following the specified user.
According to spec https://dev.twitter.com/docs/api/1.1/get/followers/list
friends.lisp (file)
Returns a list of user IDs for every user the specified user is following (otherwise known as their "friends").
According to spec https://dev.twitter.com/docs/api/1.1/get/friends/ids
friends.lisp (file)
Returns a list of user objects for every user the specified user is following (otherwise known as their "friends").
According to spec https://dev.twitter.com/docs/api/1.1/get/friends/list
friends.lisp (file)
Allows the authenticating users to follow the user specified in the ID parameter.
According to spec https://dev.twitter.com/docs/api/1.1/post/friendships/create
friends.lisp (file)
Allows the authenticating user to unfollow the user specified in the ID parameter.
According to spec https://dev.twitter.com/docs/api/1.1/post/friendships/destroy
friends.lisp (file)
Returns a collection of numeric IDs for every user who has a pending request to follow the authenticating user.
According to spec https://dev.twitter.com/docs/api/1.1/get/friendships/incoming
friends.lisp (file)
Returns the relationships of the authenticating user to the list of up to 100 screen-names or user-ids provided.
According to spec https://dev.twitter.com/docs/api/1.1/get/friendships/lookup
friends.lisp (file)
Returns a collection of user_ids that the currently authenticated user does not want to receive retweets from.
According to spec https://dev.twitter.com/docs/api/1.1/get/friendships/no_retweets/ids
friends.lisp (file)
Returns a collection of numeric IDs for every protected user for whom the authenticating user has a pending follow request.
According to spec https://dev.twitter.com/docs/api/1.1/get/friendships/outgoing
friends.lisp (file)
Returns detailed information about the relationship between two arbitrary users. The first return value is the relationship object "target", the second "source".
According to spec https://dev.twitter.com/docs/api/1.1/get/friendships/show
friends.lisp (file)
Allows one to enable or disable retweets and device notifications from the specified user.
The first return value is the relationship object "target", the second "source".
According to spec https://dev.twitter.com/docs/api/1.1/post/friendships/update
friends.lisp (file)
Turns a keyword into a key.
Replaces - with _ and downcases the keyword as a string.
This is useful to parse the request parameters from the
lisp representation into the api representation.
toolkit.lisp (file)
Generate a NONCE to use for requests. Currently this simply uses a v4-UUID.
toolkit.lisp (file)
Returns a location object containing all the information about a known place.
According to spec https://dev.twitter.com/docs/api/1.1/param/geo/id/%3Aplace_id
location.lisp (file)
Given a latitude and a longitude, searches for up to 20 places that can be used as a place_id when updating a status.
According to spec https://dev.twitter.com/docs/api/1.1/get/geo/reverse_geocode
location.lisp (file)
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.
According to spec https://dev.twitter.com/docs/api/1.1/get/geo/search
location.lisp (file)
Locates places near the given coordinates which are similar in name.
According to spec https://dev.twitter.com/docs/api/1.1/get/geo/similar_places
location.lisp (file)
Returns the current configuration used by Twitter including twitter.com slugs which are not usernames, maximum photo resolutions, and t.co URL lengths.
According to spec https://dev.twitter.com/docs/api/1.1/get/help/configuration
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.
According to spec https://dev.twitter.com/docs/api/1.1/get/help/languages
Returns Twitter’s Privacy Policy.
According to spec https://dev.twitter.com/docs/api/1.1/get/help/privacy
Returns the Twitter Terms of Service in the requested format. These are not the same as the Developer Rules of the Road.
According to spec https://dev.twitter.com/docs/api/1.1/get/help/tos
Returns a base-64 encoded string of the HMAC digest of the given STRING using the KEYSTRING as HMAC key. The encoding of *external-format* is used throughout.
toolkit.lisp (file)
Starts the authentication process and returns an URL that the user has to visit.
METHOD can be one of :PIN :SERVER or a string designating a callback URL.
See OAUTH/AUTHORIZE, INITIATE-SERVER-AUTHENTICATION and OAUTH/AUTHENTICATE respectively.
oauth.lisp (file)
Creates a new list for the authenticated user. Note that you can’t create more than 20 lists per account.
According to spec https://dev.twitter.com/docs/api/1.1/post/lists/create
lists.lisp (file)
Deletes the specified list. The authenticated user must own the list to be able to destroy it.
According to spec https://dev.twitter.com/docs/api/1.1/post/lists/destroy
lists.lisp (file)
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.
According to spec https://dev.twitter.com/docs/api/1.1/get/lists/list
lists.lisp (file)
Returns the members of the specified list. Private list members will only be shown if the authenticated user owns the specified list.
According to spec https://dev.twitter.com/docs/api/1.1/get/lists/members
lists.lisp (file)
Add a member to a list. 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.
According to spec https://dev.twitter.com/docs/api/1.1/post/lists/members/create
lists.lisp (file)
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 5,000 members, and you are limited to adding up to 100 members to a list at a time with this method.
According to spec https://dev.twitter.com/docs/api/1.1/post/lists/members/create_all
lists.lisp (file)
Removes the specified member from the list. The authenticated user must be the list’s owner to remove members from the list.
According to spec https://dev.twitter.com/docs/api/1.1/post/lists/members/destroy
lists.lisp (file)
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.
According to spec https://dev.twitter.com/docs/api/1.1/post/lists/members/destroy_all
lists.lisp (file)
Check if the specified user is a member of the specified list.
According to spec https://dev.twitter.com/docs/api/1.1/get/lists/members/show
lists.lisp (file)
Returns the lists the specified user has been added to. If user_id or screen_name are not provided the memberships for the authenticating user are returned.
According to spec https://dev.twitter.com/docs/api/1.1/get/lists/memberships
lists.lisp (file)
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.
According to spec https://dev.twitter.com/docs/api/1.1/get/lists/ownerships
lists.lisp (file)
Returns the specified list. Private lists will only be shown if the authenticated user owns the specified list.
According to spec https://dev.twitter.com/docs/api/1.1/get/lists/show
lists.lisp (file)
Returns a timeline of tweets authored by members of the specified list. Retweets are included by default. Use the include_rts=false parameter to omit retweets.
According to spec https://dev.twitter.com/docs/api/1.1/get/lists/statuses
lists.lisp (file)
Returns the subscribers of the specified list. Private list subscribers will only be shown if the authenticated user owns the specified list.
According to spec https://dev.twitter.com/docs/api/1.1/get/lists/subscribers
lists.lisp (file)
Subscribes the authenticated user to the specified list.
According to spec https://dev.twitter.com/docs/api/1.1/post/lists/subscribers/create
lists.lisp (file)
Unsubscribes the authenticated user from the specified list.
According to spec https://dev.twitter.com/docs/api/1.1/post/lists/subscribers/destroy
lists.lisp (file)
Check if the specified user is a subscriber of the specified list. Returns the user if they are subscriber.
According to spec https://dev.twitter.com/docs/api/1.1/get/lists/subscribers/show
lists.lisp (file)
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.
According to spec https://dev.twitter.com/docs/api/1.1/get/lists/subscriptions
lists.lisp (file)
Updates the specified list. The authenticated user must own the list to be able to update it.
According to spec https://dev.twitter.com/docs/api/1.1/post/lists/update
lists.lisp (file)
Applies FUNCTION to each element of the designated parameter while going through the cursor. Returns the collected return values of the FUNCTION calls.
cursor.lisp (file)
Returns T if the status is mentioning the currently identified user.
Simply checks the status entities for a user-mention that matches to the currently identified user.
statuses.lisp (file)
Turn the tokens received through the authentication into an access token.
According to spec https://dev.twitter.com/docs/auth/implementing-sign-twitter
oauth.lisp (file)
Initiate the authentication through the redirect mechanism.
Returns an URL that the user has to open in the browser.
Upon successful authentication, the page should redirect back
to the specified callback url. This callback endpoint should then
pass the proper parameters to COMPLETE-AUTHENTICATION.
According to spec https://dev.twitter.com/docs/auth/implementing-sign-twitter
oauth.lisp (file)
Initiate the authentication through the PIN mechanism.
Returns an URL that the user has to open in the browser.
This page should, upon successful authentication, return a PIN
that has to be initialized by passing it to COMPLETE-AUTHENTICATION.
According to spec https://dev.twitter.com/docs/auth/pin-based-authorization
oauth.lisp (file)
Query for a request token using the specified callback.
Returns an ALIST containing :OAUTH-TOKEN, :OAUTH-TOKEN-SECRET and
:OAUTH-CALLBACK-CONFIRMED, the first two being strings and the last a boolean.
According to spec https://dev.twitter.com/docs/auth/implementing-sign-twitter
oauth.lisp (file)
Parses a string boolean. If the string is one of (T, true, 1), then T is returned, otherwise NIL. The check is case-insensitive.
toolkit.lisp (file)
toolkit.lisp (file)
Parse a string returned by the twitter API that is of the form "Fri Mar 26 15:36:12 +0000 2010" to a local-time timestamp.
toolkit.lisp (file)
Query for a PIN based request token.
See CALLBACK-REQUEST-TOKEN.
According to spec https://dev.twitter.com/docs/auth/pin-based-authorization
oauth.lisp (file)
Filters out empty key-value pairs and turns all values into strings, ready to be sent out as request parameters. This function is DESTRUCTIVE.
toolkit.lisp (file)
Replaces the regions as marked by the entities with the result of the replacement function.
STATUS — A status object or any object with entities, or a list of entities.
REPLACEMENT-FUNCTIONS — A plist of entity-types as keys and functions with one argument as the value. Keys should
be one of :USER-MENTIONS :URLS :SYMBOLS :HASHTAGS :MEDIA. Functions should take one argument,
the entity to replace and return a string value to replace it with.
TEXT — The text to replace in. The sequence is not modified.
statuses.lisp (file)
Replaces the regions as marked by the entities with the result of the replacement function.
STATUS — A status object or any object with entities.
ENTITY-TYPE — A keyword for the entity to replace. Either :USER-MENTIONS :URLS :SYMBOLS :HASHTAGS :MEDIA
REPLACEMENT-FUNCTION — A function with one argument; the entity object currently being replaced.
TEXT — The text to replace in. The sequence is not modified.
statuses.lisp (file)
Returns T if the status is a retweet.
To qualify as a retweet, the tweet has to either contain a RETWEETED-STATUS, or start with "RT".
statuses.lisp (file)
Create a new saved search for the authenticated user. A user may only have 25 saved searches.
According to spec https://dev.twitter.com/docs/api/1.1/post/saved_searches/create
saved-searches.lisp (file)
Destroys a saved search for the authenticating user. The authenticating user must be the owner of saved search id being destroyed.
According to spec https://dev.twitter.com/docs/api/1.1/post/saved_searches/destroy/%3Aid
saved-searches.lisp (file)
Returns the authenticated user’s saved search queries.
According to spec https://dev.twitter.com/docs/api/1.1/get/saved_searches/list
saved-searches.lisp (file)
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.
According to spec https://dev.twitter.com/docs/api/1.1/get/saved_searches/show/%3Aid
saved-searches.lisp (file)
Returns a collection of relevant Tweets matching a specified query and some search metadata as a second value.
According to spec https://dev.twitter.com/docs/api/1.1/get/search/tweets
search.lisp (file)
Turns all object slots into an ALIST. Requires CLOSER-MOP to be installed.
toolkit.lisp (file)
Issue a signed data request against the API.
See SIGNED-REQUEST.
According to spec https://dev.twitter.com/docs/uploading-media
oauth.lisp (file)
Issue a signed request against the API.
This requires the *oauth-api-key*, *oauth-signature-method*,
*oauth-version* and at least *oauth-api-secret* to be set.
See CREATE-SIGNATURE.
For return values see DRAKMA:HTTP-REQUEST
According to spec https://dev.twitter.com/docs/auth/authorizing-request
oauth.lisp (file)
Issue a signed data request against the API.
See SIGNED-REQUEST. Returns values according to DRAKMA:HTTP-REQUEST with :WANT-STREAM T
oauth.lisp (file)
Destroys the status specified by the required ID parameter. The authenticating user must be the author of the specified status. Returns the destroyed status if successful.
According to spec https://dev.twitter.com/docs/api/1.1/post/statuses/destroy/%3Aid
statuses.lisp (file)
Returns a collection of the most recent Tweets and retweets posted by the authenticating user and the users they follow. The home timeline is central to how most users interact with the Twitter service.
According to spec https://dev.twitter.com/docs/api/1.1/get/statuses/home_timeline
timelines.lisp (file)
Returns the 20 most recent mentions (tweets containing a users’s @screen_name) for the authenticating user.
According to spec https://dev.twitter.com/docs/api/1.1/get/statuses/mentions_timeline
timelines.lisp (file)
Returns information allowing the creation of an embedded representation of a Tweet on third party sites. See the oEmbed specification for information about the response format.
According to spec https://dev.twitter.com/docs/api/1.1/get/statuses/oembed
statuses.lisp (file)
Retweets a tweet. Returns the original tweet with retweet details embedded.
According to spec https://dev.twitter.com/docs/api/1.1/post/statuses/retweet/%3Aid
statuses.lisp (file)
Returns a collection of up to 100 user IDs belonging to users who have retweeted the tweet specified by the id parameter.
According to spec https://dev.twitter.com/docs/api/1.1/get/statuses/retweeters/ids
statuses.lisp (file)
Returns a collection of the 100 most recent retweets of the tweet specified by the id parameter.
According to spec https://dev.twitter.com/docs/api/1.1/get/statuses/retweets/%3Aid
statuses.lisp (file)
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.
According to spec https://dev.twitter.com/docs/api/1.1/get/statuses/retweets_of_me
timelines.lisp (file)
Returns a single Tweet, specified by the id parameter. The Tweet’s author will also be embedded within the tweet.
According to spec https://dev.twitter.com/docs/api/1.1/get/statuses/show/%3Aid
statuses.lisp (file)
Updates the authenticating user’s current status, also known as tweeting. To upload an image to accompany the tweet, use POST statuses/update_with_media.
According to spec https://dev.twitter.com/docs/api/1.1/post/statuses/update
statuses.lisp (file)
Updates the authenticating user’s current status and attaches media for upload. In other words, it creates a Tweet with a picture attached. MEDIA is either a pathname, usb-8 array or a base64-encoded string, or a list thereof.
According to spec https://dev.twitter.com/docs/api/1.1/post/statuses/update_with_media
statuses.lisp (file)
Returns a collection of the most recent Tweets posted by the user indicated by the screen_name or user_id parameters.
According to spec https://dev.twitter.com/docs/api/1.1/get/statuses/user_timeline
timelines.lisp (file)
Streams messages for a set of users, as described in Site streams.
See STREAM/USER.
According to spec https://dev.twitter.com/docs/api/1.1/get/site https://dev.twitter.com/docs/streaming-apis/streams/site https://dev.twitter.com/docs/streaming-apis/messages
stream.lisp (file)
Returns public statuses that match one or more filter predicates. Multiple parameters may be specified which allows most clients to use a single connection to the Streaming API. Both GET and POST requests are supported, but GET requests with too many parameters may cause the request to be rejected for excessive URL length. Use a POST request to avoid long URLs.
See STREAM/USER.
According to spec https://dev.twitter.com/docs/api/1.1/post/statuses/filter
https://dev.twitter.com/docs/streaming-apis/messages
stream.lisp (file)
Returns all public statuses. Few applications require this level of access. Creative use of a combination of other resources and various access levels can satisfy nearly every application use case.
This endpoint requires special permission to access.
According to spec https://dev.twitter.com/docs/api/1.1/get/statuses/firehose
https://dev.twitter.com/docs/streaming-apis/messages
stream.lisp (file)
Returns a small random sample of all public statuses. The Tweets returned by the default access level are the same, so if two different clients connect to this endpoint, they will see the same Tweets.
According to spec https://dev.twitter.com/docs/api/1.1/get/statuses/sample
https://dev.twitter.com/docs/streaming-apis/messages
stream.lisp (file)
Streams messages for a single user, as described in User streams.
Each line is parsed into an appropriate object (NIL for empty lines) and passed to the handler function.
This is done as long as the handler function returns a non-NIL value. Once the handler returns NIL,
the loop is stopped and the stream is closed.
According to spec https://dev.twitter.com/docs/api/1.1/get/user https://dev.twitter.com/docs/streaming-apis/streams/user https://dev.twitter.com/docs/streaming-apis/messages
stream.lisp (file)
Replaces the shortened links with the resolved entity urls if possible.
statuses.lisp (file)
Transforms the text into a HTML-ready form.
This includes the following changes related to entities:
URLS -> <a href="URL" title="EXPANDED-URL">DISPLAY-URL</a>
USER-MENTIONS -> <a href="http://twitter.com/SCREEN-NAME" title="NAME">@SCREEN-NAME</a>
HASHTAGS -> <a href="http://twitter.com/search?q=%23HASHTAG">#HASHTAG</a>
MEDIA -> <a href="URL" title="EXPANDED-URL">DISPLAY-URL</a>
The tweet status text is also correctly escaped with entities for <, >, &.
If APPEND-MEDIA is non-NIL, an <img> tag with the related SRC and ALT attributes is appended to the text if a media entity exists.
APPEND-MEDIA can be one of :LARGE :MEDIUM :SMALL :THUMB, which sets the proper width and height attributes and loads the respective image.
The size defaults to :THUMB.
statuses.lisp (file)
Turns a key into a keyword.
Replaces _ with - and uppercases the string, then interns it
into the keyword package. This is useful to parse the request
responses into an alist.
toolkit.lisp (file)
Returns the locations that Twitter has trending topic information for.
According to spec https://api.twitter.com/1.1/trends/available.json
trends.lisp (file)
Returns the locations that Twitter has trending topic information for, closest to a specified location.
According to spec https://dev.twitter.com/docs/api/1.1/get/trends/closest
trends.lisp (file)
Returns the top 10 trending topics for a specific WOEID, if trending information is available for it.
According to spec https://api.twitter.com/1.1/trends/place.json
trends.lisp (file)
Returns a URL-encoded version of the string STRING using the external format EXTERNAL-FORMAT.
According to spec https://dev.twitter.com/docs/auth/percent-encoding-parameters
toolkit.lisp (file)
Returns a list of users that the specified user can "contribute" to.
According to spec https://dev.twitter.com/docs/api/1.1/get/users/contributees
Returns a list of users who can contribute to the specified account.
According to spec https://dev.twitter.com/docs/api/1.1/get/users/contributors
Returns fully-hydrated user objects for up to 100 users per request, as specified by the lists passed to the user_id and/or screen_name parameters.
According to spec https://dev.twitter.com/docs/api/1.1/get/users/lookup
Returns a map of the available size variations of the specified user’s profile banner. If the user has not uploaded a profile banner, a HTTP 404 will be served instead. This method can be used instead of string manipulation on the profile_banner_url returned in user objects as described in User Profile Images and Banners.
According to spec https://dev.twitter.com/docs/api/1.1/get/users/profile_banner
Report the specified user as a spam account to Twitter. Additionally performs the equivalent of POST blocks/create on behalf of the authenticated user.
According to spec https://dev.twitter.com/docs/api/1.1/post/users/report_spam
Provides a simple, relevance-based search interface to public user accounts on Twitter. Try querying by topical interest, full name, company name, location, or other criteria. Exact match searches are not supported.
According to spec https://dev.twitter.com/docs/api/1.1/get/users/search
Returns a variety of information about the user specified by the required user_id or screen_name parameter. The author’s most recent Tweet will be returned inline when possible.
According to spec https://dev.twitter.com/docs/api/1.1/get/users/show
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.
According to spec https://dev.twitter.com/docs/api/1.1/get/users/suggestions
suggestions.lisp (file)
Access the users in a given category of the Twitter suggested user list.
According to spec https://dev.twitter.com/docs/api/1.1/get/users/suggestions/%3Aslug
suggestions.lisp (file)
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.
According to spec https://dev.twitter.com/docs/api/1.1/get/users/suggestions/%3Aslug/members
suggestions.lisp (file)
Returns T if the given language code is a language covered by twitter.
See HELP/LANGUAGES.
help.lisp (file)
Transforms < > & into their proper characters.
toolkit.lisp (file)
Transforms & < > into their proper entities.
toolkit.lisp (file)
Next: Exported conditions, Previous: Exported functions, Up: Exported definitions [Contents][Index]
automatically generated reader method
friends.lisp (file)
automatically generated writer method
friends.lisp (file)
automatically generated reader method
collections.lisp (file)
automatically generated writer method
collections.lisp (file)
automatically generated reader method
statuses.lisp (file)
automatically generated writer method
statuses.lisp (file)
automatically generated reader method
statuses.lisp (file)
automatically generated writer method
statuses.lisp (file)
Blocks the given user as per BLOCKS/CREATE. Returns a new user object.
generics.lisp (file)
automatically generated reader method
friends.lisp (file)
automatically generated writer method
friends.lisp (file)
automatically generated reader method
location.lisp (file)
automatically generated writer method
location.lisp (file)
automatically generated reader method
statuses.lisp (file)
automatically generated writer method
statuses.lisp (file)
automatically generated reader method
friends.lisp (file)
automatically generated writer method
friends.lisp (file)
automatically generated reader method
stream.lisp (file)
automatically generated writer method
stream.lisp (file)
automatically generated reader method
stream.lisp (file)
automatically generated writer method
stream.lisp (file)
automatically generated reader method
help.lisp (file)
automatically generated writer method
help.lisp (file)
automatically generated reader method
collections.lisp (file)
automatically generated writer method
collections.lisp (file)
automatically generated reader method
search.lisp (file)
automatically generated writer method
search.lisp (file)
automatically generated reader method
friends.lisp (file)
automatically generated writer method
friends.lisp (file)
automatically generated reader method
location.lisp (file)
automatically generated writer method
location.lisp (file)
automatically generated reader method
statuses.lisp (file)
automatically generated writer method
statuses.lisp (file)
automatically generated reader method
user.lisp (file)
automatically generated writer method
user.lisp (file)
automatically generated reader method
stream.lisp (file)
automatically generated writer method
stream.lisp (file)
automatically generated reader method
account.lisp (file)
automatically generated writer method
account.lisp (file)
automatically generated reader method
statuses.lisp (file)
automatically generated writer method
statuses.lisp (file)
automatically generated reader method
location.lisp (file)
automatically generated writer method
location.lisp (file)
automatically generated reader method
trends.lisp (file)
automatically generated writer method
trends.lisp (file)
automatically generated reader method
trends.lisp (file)
automatically generated writer method
trends.lisp (file)
automatically generated reader method
location.lisp (file)
automatically generated writer method
location.lisp (file)
automatically generated reader method
location.lisp (file)
automatically generated writer method
location.lisp (file)
automatically generated reader method
lists.lisp (file)
automatically generated writer method
lists.lisp (file)
automatically generated reader method
statuses.lisp (file)
automatically generated writer method
statuses.lisp (file)
automatically generated reader method
user.lisp (file)
automatically generated writer method
user.lisp (file)
automatically generated reader method
stream.lisp (file)
automatically generated writer method
stream.lisp (file)
automatically generated reader method
lists.lisp (file)
automatically generated writer method
lists.lisp (file)
automatically generated reader method
saved-searches.lisp (file)
automatically generated writer method
saved-searches.lisp (file)
automatically generated reader method
direct-messages.lisp (file)
automatically generated writer method
direct-messages.lisp (file)
automatically generated reader method
statuses.lisp (file)
automatically generated writer method
statuses.lisp (file)
automatically generated reader method
user.lisp (file)
automatically generated writer method
user.lisp (file)
Moves the cursor to the next iteration if possible and saves the data in the cursor object. If no additional data is available, NIL is returned instead.
cursor.lisp (file)
Moves the cursor to the previous iteration if possible and saves the data in the cursor object. If no additional data is available, NIL is returned instead.
cursor.lisp (file)
Perform the currently stored cursor request and save the data in the cursor object.
cursor.lisp (file)
automatically generated reader method
stream.lisp (file)
automatically generated writer method
stream.lisp (file)
automatically generated reader method
cursor.lisp (file)
automatically generated writer method
cursor.lisp (file)
Deletes the given object.
generics.lisp (file)
Deletes the given STATUS as per STATUSES/DESTROY. Returns a new STATUS object.
Deletes the given DIRECT-MESSAGE as per DIRECT-MESSAGES/DESTROY. Returns a new DIRECT-MESSAGE object.
Deletes the given USER-LIST as per LISTS/DESTROY. Returns a new USER-LIST object.
Deltes the given SAVED-SEARCH as per SAVED-SEARCHES/DESTROY/ID. Returns a new SAVED-SEARCH object.
automatically generated reader method
lists.lisp (file)
automatically generated writer method
lists.lisp (file)
automatically generated reader method
user.lisp (file)
automatically generated writer method
user.lisp (file)
automatically generated reader method
statuses.lisp (file)
automatically generated writer method
statuses.lisp (file)
automatically generated reader method
entities.lisp (file)
automatically generated writer method
entities.lisp (file)
automatically generated reader method
entities.lisp (file)
automatically generated writer method
entities.lisp (file)
automatically generated reader method
account.lisp (file)
automatically generated writer method
account.lisp (file)
automatically generated reader method
entities.lisp (file)
automatically generated writer method
entities.lisp (file)
automatically generated reader method
entities.lisp (file)
automatically generated writer method
entities.lisp (file)
automatically generated reader method
entities.lisp (file)
automatically generated writer method
entities.lisp (file)
automatically generated reader method
entities.lisp (file)
automatically generated writer method
entities.lisp (file)
automatically generated reader method
entities.lisp (file)
automatically generated writer method
entities.lisp (file)
automatically generated reader method
direct-messages.lisp (file)
automatically generated writer method
direct-messages.lisp (file)
automatically generated reader method
statuses.lisp (file)
automatically generated writer method
statuses.lisp (file)
automatically generated reader method
user.lisp (file)
automatically generated writer method
user.lisp (file)
automatically generated reader method
trends.lisp (file)
automatically generated writer method
trends.lisp (file)
automatically generated reader method
entities.lisp (file)
automatically generated writer method
entities.lisp (file)
automatically generated reader method
entities.lisp (file)
automatically generated writer method
entities.lisp (file)
automatically generated reader method
statuses.lisp (file)
automatically generated writer method
statuses.lisp (file)
Favorites the given status as per FAVORITES/CREATE. Returns a new STATUS object.
generics.lisp (file)
automatically generated reader method
statuses.lisp (file)
automatically generated writer method
statuses.lisp (file)
Fetches the user object associated with the given object.
This always returns a fresh object and always results in a server call.
generics.lisp (file)
Fetches the user associated with the given ID.
Fetches the user associated with the given screen name.
Fetches all users in the list. A list of IDs or screen names will be fetched through USERS/LOOKUP and is thus faster.
Fetches the authenticated user object (ACCOUNT/SELF).
Fetches the complete user object.
Fetches the user associated with the status.
Fetches the user associated with the direct-message.
Fetches the user associated with the relationship.
Fetches the owner of the user-list.
Fetches all suggested users in the slug.
Follows the given user as per FRIENDSHIPS/CREATE. Returns a new user object.
generics.lisp (file)
automatically generated reader method
friends.lisp (file)
automatically generated writer method
friends.lisp (file)
automatically generated reader method
lists.lisp (file)
automatically generated writer method
lists.lisp (file)
automatically generated reader method
friends.lisp (file)
automatically generated writer method
friends.lisp (file)
automatically generated reader method
user.lisp (file)
automatically generated writer method
user.lisp (file)
automatically generated reader method
stream.lisp (file)
automatically generated writer method
stream.lisp (file)
automatically generated reader method
account.lisp (file)
automatically generated writer method
account.lisp (file)
automatically generated reader method
stream.lisp (file)
automatically generated writer method
stream.lisp (file)
automatically generated reader method
lists.lisp (file)
automatically generated writer method
lists.lisp (file)
automatically generated reader method
location.lisp (file)
automatically generated writer method
location.lisp (file)
automatically generated reader method
statuses.lisp (file)
automatically generated writer method
statuses.lisp (file)
automatically generated reader method
account.lisp (file)
automatically generated writer method
account.lisp (file)
automatically generated reader method
statuses.lisp (file)
automatically generated writer method
statuses.lisp (file)
automatically generated reader method
user.lisp (file)
automatically generated writer method
user.lisp (file)
automatically generated reader method
entities.lisp (file)
automatically generated writer method
entities.lisp (file)
automatically generated reader method
statuses.lisp (file)
automatically generated writer method
statuses.lisp (file)
oauth.lisp (file)
oauth.lisp (file)
oauth.lisp (file)
automatically generated reader method
collections.lisp (file)
automatically generated writer method
collections.lisp (file)
automatically generated reader method
stream.lisp (file)
automatically generated writer method
stream.lisp (file)
automatically generated reader method
stream.lisp (file)
automatically generated writer method
stream.lisp (file)
automatically generated reader method
stream.lisp (file)
automatically generated writer method
stream.lisp (file)
automatically generated reader method
lists.lisp (file)
automatically generated writer method
lists.lisp (file)
automatically generated reader method
saved-searches.lisp (file)
automatically generated writer method
saved-searches.lisp (file)
automatically generated reader method
friends.lisp (file)
automatically generated writer method
friends.lisp (file)
automatically generated reader method
direct-messages.lisp (file)
automatically generated writer method
direct-messages.lisp (file)
automatically generated reader method
statuses.lisp (file)
automatically generated writer method
statuses.lisp (file)
automatically generated reader method
user.lisp (file)
automatically generated writer method
user.lisp (file)
automatically generated reader method
cursor.lisp (file)
automatically generated writer method
cursor.lisp (file)
automatically generated reader method
entities.lisp (file)
automatically generated writer method
entities.lisp (file)
automatically generated reader method
entities.lisp (file)
automatically generated writer method
entities.lisp (file)
automatically generated reader method
location.lisp (file)
automatically generated writer method
location.lisp (file)
automatically generated reader method
statuses.lisp (file)
automatically generated writer method
statuses.lisp (file)
automatically generated reader method
account.lisp (file)
automatically generated writer method
account.lisp (file)
automatically generated reader method
user.lisp (file)
automatically generated writer method
user.lisp (file)
automatically generated reader method
location.lisp (file)
automatically generated writer method
location.lisp (file)
Adds the given user to the given list as per LISTS/MEMBERS/CREATE. Returns the given USER identifying object.
generics.lisp (file)
automatically generated reader method
location.lisp (file)
automatically generated writer method
location.lisp (file)
automatically generated reader method
location.lisp (file)
automatically generated writer method
location.lisp (file)
Continuously apply HANDLER-FUNCTION to each STATUS appearing in the given TIMELINE.
Before fetching new tweets, a COOLDOWN amount of seconds are slept to avoid spamming.
Each time after a fetch, HANDLER-FUNCTION is applied to each status returned by the fetch.
Internally, the :SINCE-ID argument is supplied to each subsequent request to assure that only
new statuses are fetched on every iteration.
Depending on which timeline is requested, additional keyword arguments may be supplied.
See the individual STATUSES/* functions for further reference.
generics.lisp (file)
automatically generated reader method
friends.lisp (file)
automatically generated writer method
friends.lisp (file)
automatically generated reader method
search.lisp (file)
automatically generated writer method
search.lisp (file)
automatically generated reader method
entities.lisp (file)
automatically generated writer method
entities.lisp (file)
automatically generated reader method
entities.lisp (file)
automatically generated writer method
entities.lisp (file)
automatically generated reader method
entities.lisp (file)
automatically generated writer method
entities.lisp (file)
Creates a new mentioning status (@user ..) as per TWEET!. Returns the new STATUS object.
generics.lisp (file)
automatically generated reader method
stream.lisp (file)
automatically generated writer method
stream.lisp (file)
automatically generated reader method
stream.lisp (file)
automatically generated writer method
stream.lisp (file)
Sends a direct message to the given user as per DIRECT-MESSAGES/NEW. Returns the new DIRECT-MESSAGE Object.
generics.lisp (file)
automatically generated reader method
lists.lisp (file)
automatically generated writer method
lists.lisp (file)
automatically generated reader method
collections.lisp (file)
automatically generated writer method
collections.lisp (file)
automatically generated reader method
lists.lisp (file)
automatically generated writer method
lists.lisp (file)
automatically generated reader method
saved-searches.lisp (file)
automatically generated writer method
saved-searches.lisp (file)
automatically generated reader method
friends.lisp (file)
automatically generated writer method
friends.lisp (file)
automatically generated reader method
suggestions.lisp (file)
automatically generated writer method
suggestions.lisp (file)
automatically generated reader method
user.lisp (file)
automatically generated writer method
user.lisp (file)
automatically generated reader method
help.lisp (file)
automatically generated writer method
help.lisp (file)
automatically generated reader method
entities.lisp (file)
automatically generated writer method
entities.lisp (file)
automatically generated reader method
trends.lisp (file)
automatically generated writer method
trends.lisp (file)
automatically generated reader method
trends.lisp (file)
automatically generated writer method
trends.lisp (file)
automatically generated reader method
location.lisp (file)
automatically generated writer method
location.lisp (file)
automatically generated reader method
search.lisp (file)
automatically generated writer method
search.lisp (file)
automatically generated reader method
friends.lisp (file)
automatically generated writer method
friends.lisp (file)
automatically generated reader method
statuses.lisp (file)
automatically generated writer method
statuses.lisp (file)
automatically generated reader method
collections.lisp (file)
automatically generated writer method
collections.lisp (file)
oauth.lisp (file)
automatically generated reader method
cursor.lisp (file)
automatically generated writer method
cursor.lisp (file)
automatically generated reader method
trends.lisp (file)
automatically generated writer method
trends.lisp (file)
automatically generated reader method
statuses.lisp (file)
automatically generated writer method
statuses.lisp (file)
automatically generated reader method
trends.lisp (file)
automatically generated writer method
trends.lisp (file)
automatically generated reader method
trends.lisp (file)
automatically generated writer method
trends.lisp (file)
automatically generated reader method
location.lisp (file)
automatically generated writer method
location.lisp (file)
automatically generated reader method
statuses.lisp (file)
automatically generated writer method
statuses.lisp (file)
automatically generated reader method
trends.lisp (file)
automatically generated writer method
trends.lisp (file)
automatically generated reader method
account.lisp (file)
automatically generated writer method
account.lisp (file)
automatically generated reader method
user.lisp (file)
automatically generated writer method
user.lisp (file)
automatically generated reader method
statuses.lisp (file)
automatically generated writer method
statuses.lisp (file)
automatically generated reader method
statuses.lisp (file)
automatically generated writer method
statuses.lisp (file)
automatically generated reader method
search.lisp (file)
automatically generated writer method
search.lisp (file)
automatically generated reader method
saved-searches.lisp (file)
automatically generated writer method
saved-searches.lisp (file)
automatically generated reader method
trends.lisp (file)
automatically generated writer method
trends.lisp (file)
automatically generated reader method
stream.lisp (file)
automatically generated writer method
stream.lisp (file)
automatically generated reader method
direct-messages.lisp (file)
automatically generated writer method
direct-messages.lisp (file)
automatically generated reader method
search.lisp (file)
automatically generated writer method
search.lisp (file)
Replies to the given status, mentioning only the status’ owner (@user ..) as per TWEET!. Returns the new STATUS object.
generics.lisp (file)
Replies to all mentioned users in the tweet as per TWEET!. Returns the new STATUS object.
generics.lisp (file)
Reports the given user for spam and blocks it as per USERS/REPORT-SPAM. Returns a new user object.
generics.lisp (file)
automatically generated reader method
cursor.lisp (file)
automatically generated writer method
cursor.lisp (file)
automatically generated reader method
entities.lisp (file)
automatically generated writer method
entities.lisp (file)
automatically generated reader method
search.lisp (file)
automatically generated writer method
search.lisp (file)
Retweets the given status as per STATUSES/RETWEET. Returns the new STATUS object.
generics.lisp (file)
automatically generated reader method
statuses.lisp (file)
automatically generated writer method
statuses.lisp (file)
automatically generated reader method
statuses.lisp (file)
automatically generated writer method
statuses.lisp (file)
automatically generated reader method
friends.lisp (file)
automatically generated writer method
friends.lisp (file)
automatically generated reader method
account.lisp (file)
automatically generated writer method
account.lisp (file)
automatically generated reader method
user.lisp (file)
automatically generated writer method
user.lisp (file)
automatically generated reader method
entities.lisp (file)
automatically generated writer method
entities.lisp (file)
automatically generated reader method
saved-searches.lisp (file)
automatically generated writer method
saved-searches.lisp (file)
automatically generated reader method
direct-messages.lisp (file)
automatically generated writer method
direct-messages.lisp (file)
automatically generated reader method
location.lisp (file)
automatically generated writer method
location.lisp (file)
automatically generated reader method
account.lisp (file)
automatically generated writer method
account.lisp (file)
automatically generated reader method
user.lisp (file)
automatically generated writer method
user.lisp (file)
automatically generated reader method
search.lisp (file)
automatically generated writer method
search.lisp (file)
automatically generated reader method
suggestions.lisp (file)
automatically generated writer method
suggestions.lisp (file)
automatically generated reader method
user.lisp (file)
automatically generated writer method
user.lisp (file)
automatically generated reader method
entities.lisp (file)
automatically generated writer method
entities.lisp (file)
automatically generated reader method
entities.lisp (file)
automatically generated writer method
entities.lisp (file)
automatically generated reader method
account.lisp (file)
automatically generated writer method
account.lisp (file)
automatically generated reader method
account.lisp (file)
automatically generated writer method
account.lisp (file)
automatically generated reader method
account.lisp (file)
automatically generated writer method
account.lisp (file)
automatically generated reader method
lists.lisp (file)
automatically generated writer method
lists.lisp (file)
automatically generated reader method
suggestions.lisp (file)
automatically generated writer method
suggestions.lisp (file)
automatically generated reader method
stream.lisp (file)
automatically generated writer method
stream.lisp (file)
automatically generated reader method
statuses.lisp (file)
automatically generated writer method
statuses.lisp (file)
automatically generated reader method
entities.lisp (file)
automatically generated writer method
entities.lisp (file)
automatically generated reader method
entities.lisp (file)
automatically generated writer method
entities.lisp (file)
automatically generated reader method
entities.lisp (file)
automatically generated writer method
entities.lisp (file)
automatically generated reader method
entities.lisp (file)
automatically generated writer method
entities.lisp (file)
automatically generated reader method
entities.lisp (file)
automatically generated writer method
entities.lisp (file)
automatically generated reader method
entities.lisp (file)
automatically generated writer method
entities.lisp (file)
Starts the streaming process as per the STREAM/ functions. Depending on the filter, a different stream is started. FILTER can be of type USER, LOCATION, GEOMETRY, STRING, NULL or :USER, :SITE, :SAMPLE, :FILTER or :FIREHOSE.
generics.lisp (file)
automatically generated reader method
user.lisp (file)
automatically generated writer method
user.lisp (file)
automatically generated reader method
help.lisp (file)
automatically generated writer method
help.lisp (file)
automatically generated reader method
stream.lisp (file)
automatically generated writer method
stream.lisp (file)
Subscribes to the given list as per LISTS/SUBSCRIBERS/CREATE. Returns a new USER-LIST object.
generics.lisp (file)
automatically generated reader method
stream.lisp (file)
automatically generated writer method
stream.lisp (file)
oauth.lisp (file)
oauth.lisp (file)
automatically generated reader method
stream.lisp (file)
automatically generated writer method
stream.lisp (file)
oauth.lisp (file)
oauth.lisp (file)
automatically generated reader method
direct-messages.lisp (file)
automatically generated writer method
direct-messages.lisp (file)
automatically generated reader method
statuses.lisp (file)
automatically generated writer method
statuses.lisp (file)
automatically generated reader method
entities.lisp (file)
automatically generated writer method
entities.lisp (file)
automatically generated reader method
entities.lisp (file)
automatically generated writer method
entities.lisp (file)
automatically generated reader method
account.lisp (file)
automatically generated writer method
account.lisp (file)
automatically generated reader method
account.lisp (file)
automatically generated writer method
account.lisp (file)
automatically generated reader method
account.lisp (file)
automatically generated writer method
account.lisp (file)
automatically generated reader method
stream.lisp (file)
automatically generated writer method
stream.lisp (file)
automatically generated reader method
account.lisp (file)
automatically generated writer method
account.lisp (file)
automatically generated reader method
statuses.lisp (file)
automatically generated writer method
statuses.lisp (file)
Creates a new status as per STATUSES/UPDATE or STATUSES/UPDATE-WITH-MEDIA if FILE is given. Returns the new STATUS object.
generics.lisp (file)
automatically generated reader method
collections.lisp (file)
automatically generated writer method
collections.lisp (file)
Unblocks the given user as per BLOCKS/DESTROY. Returns a new user object.
generics.lisp (file)
Unfavorites the given status as per FAVORITES/DESTROY. Returns a new STATUS object.
generics.lisp (file)
Unfollows the given user as per FRIENDSHIPS/DESTROY. Returns a new user object.
generics.lisp (file)
Removes the given user from the given list as per LISTS/MEMBERS/DESTROY-ALL. Returns the given USER identifying object.
generics.lisp (file)
Unsubscribes from the given list as per LISTS/SUBSCRIBERS/DESTROY. REturns a new USER-LIST object.
generics.lisp (file)
automatically generated reader method
stream.lisp (file)
automatically generated writer method
stream.lisp (file)
automatically generated reader method
lists.lisp (file)
automatically generated writer method
lists.lisp (file)
automatically generated reader method
collections.lisp (file)
automatically generated writer method
collections.lisp (file)
automatically generated reader method
statuses.lisp (file)
automatically generated writer method
statuses.lisp (file)
automatically generated reader method
user.lisp (file)
automatically generated writer method
user.lisp (file)
automatically generated reader method
user.lisp (file)
automatically generated writer method
user.lisp (file)
automatically generated reader method
cursor.lisp (file)
automatically generated writer method
cursor.lisp (file)
automatically generated reader method
entities.lisp (file)
automatically generated writer method
entities.lisp (file)
automatically generated reader method
entities.lisp (file)
automatically generated writer method
entities.lisp (file)
automatically generated reader method
trends.lisp (file)
automatically generated writer method
trends.lisp (file)
automatically generated reader method
trends.lisp (file)
automatically generated writer method
trends.lisp (file)
automatically generated reader method
location.lisp (file)
automatically generated writer method
location.lisp (file)
automatically generated reader method
lists.lisp (file)
automatically generated writer method
lists.lisp (file)
automatically generated reader method
statuses.lisp (file)
automatically generated writer method
statuses.lisp (file)
automatically generated reader method
collections.lisp (file)
automatically generated writer method
collections.lisp (file)
automatically generated reader method
stream.lisp (file)
automatically generated writer method
stream.lisp (file)
automatically generated reader method
stream.lisp (file)
automatically generated writer method
stream.lisp (file)
automatically generated reader method
stream.lisp (file)
automatically generated writer method
stream.lisp (file)
automatically generated reader method
collections.lisp (file)
automatically generated writer method
collections.lisp (file)
automatically generated reader method
suggestions.lisp (file)
automatically generated writer method
suggestions.lisp (file)
automatically generated reader method
statuses.lisp (file)
automatically generated writer method
statuses.lisp (file)
automatically generated reader method
collections.lisp (file)
automatically generated writer method
collections.lisp (file)
automatically generated reader method
friends.lisp (file)
automatically generated writer method
friends.lisp (file)
automatically generated reader method
statuses.lisp (file)
automatically generated writer method
statuses.lisp (file)
automatically generated reader method
user.lisp (file)
automatically generated writer method
user.lisp (file)
automatically generated reader method
entities.lisp (file)
automatically generated writer method
entities.lisp (file)
automatically generated reader method
stream.lisp (file)
automatically generated writer method
stream.lisp (file)
automatically generated reader method
stream.lisp (file)
automatically generated writer method
stream.lisp (file)
automatically generated reader method
statuses.lisp (file)
automatically generated writer method
statuses.lisp (file)
automatically generated reader method
user.lisp (file)
automatically generated writer method
user.lisp (file)
automatically generated reader method
trends.lisp (file)
automatically generated writer method
trends.lisp (file)
Next: Exported classes, Previous: Exported generic functions, Up: Exported definitions [Contents][Index]
oauth.lisp (file)
error (condition)
oauth.lisp (file)
oauth-error (condition)
:parameter
parameter (generic function)
(setf parameter) (generic function)
oauth.lisp (file)
oauth-error (condition)
:status
http-status (generic function)
(setf http-status) (generic function)
:body
http-body (generic function)
(setf http-body) (generic function)
:headers
http-headers (generic function)
(setf http-headers) (generic function)
:url
target-url (generic function)
(setf target-url) (generic function)
:method
target-method (generic function)
(setf target-method) (generic function)
:parameters
target-parameters (generic function)
(setf target-parameters) (generic function)
:sent-headers
target-headers (generic function)
(setf target-headers) (generic function)
Previous: Exported conditions, Up: Exported definitions [Contents][Index]
Class representation of a banner as returned by users/profile-banner.
user.lisp (file)
standard-object (class)
:size
size (generic function)
(setf size) (generic function)
:width
width (generic function)
(setf width) (generic function)
:height
height (generic function)
(setf height) (generic function)
:url
url (generic function)
(setf url) (generic function)
Class representation of the twitter configuration object.
According to spec https://dev.twitter.com/docs/api/1.1/get/help/configuration
help.lisp (file)
standard-object (class)
:photo-size-limit
photo-size-limit (generic function)
(setf photo-size-limit) (generic function)
:photo-sizes
photo-sizes (generic function)
(setf photo-sizes) (generic function)
:short-url-length
short-url-length (generic function)
(setf short-url-length) (generic function)
:short-url-length-https
short-url-length-https (generic function)
(setf short-url-length-https) (generic function)
:non-username-paths
non-username-paths (generic function)
(setf non-username-paths) (generic function)
:max-media-per-upload
max-media-per-upload (generic function)
(setf max-media-per-upload) (generic function)
:characters-reserved-per-media
characters-reserved-per-media (generic function)
(setf characters-reserved-per-media) (generic function)
:dm-text-character-limit
dm-text-character-limit (generic function)
(setf dm-text-character-limit) (generic function)
Cursor object to traverse cursored sets.
According to https://dev.twitter.com/docs/misc/cursoring
cursor.lisp (file)
standard-object (class)
:url
url (generic function)
(setf url) (generic function)
:parameters
parameters (generic function)
(setf parameters) (generic function)
:data
data (generic function)
(setf data) (generic function)
:request-method
request-method (generic function)
(setf request-method) (generic function)
Class representation of a twitter direct-message object.
direct-messages.lisp (file)
standard-object (class)
:text
text (generic function)
(setf text) (generic function)
:recipient
recipient (generic function)
(setf recipient) (generic function)
:sender
sender (generic function)
(setf sender) (generic function)
:created-at
created-at (generic function)
(setf created-at) (generic function)
:entities
entities (generic function)
(setf entities) (generic function)
Base class for twitter entity objects.
According to spec https://dev.twitter.com/docs/entities
entities.lisp (file)
standard-object (class)
User deauthorize event
stream.lisp (file)
stream-event (class)
event
stream.lisp (file)
stream-event (class)
event
stream.lisp (file)
stream-event (class)
event
stream.lisp (file)
stream-event (class)
event
stream.lisp (file)
stream-event (class)
event
stream.lisp (file)
stream-event (class)
event
stream.lisp (file)
stream-event (class)
event
stream.lisp (file)
stream-event (class)
event
stream.lisp (file)
stream-event (class)
event
stream.lisp (file)
stream-event (class)
event
stream.lisp (file)
stream-event (class)
event
stream.lisp (file)
stream-event (class)
event
stream.lisp (file)
stream-event (class)
event
stream.lisp (file)
stream-event (class)
Unknown stream event
stream.lisp (file)
stream-event (class)
event
stream.lisp (file)
stream-event (class)
Object for locations containing geometrical shape data.
location.lisp (file)
standard-object (class)
:shape
shape (generic function)
(setf shape) (generic function)
:coordinates
coordinates (generic function)
(setf coordinates) (generic function)
Initarg | Value |
---|---|
:shape | (error "shape type required") |
:coordinates | nil |
Twitter hashtag entity.
According to spec https://dev.twitter.com/docs/entities#The_hashtags_entity
entities.lisp (file)
entity (class)
:text
text (generic function)
(setf text) (generic function)
:start
start (generic function)
(setf start) (generic function)
:end
end (generic function)
(setf end) (generic function)
Class representation of the twitter language object.
According to spec https://dev.twitter.com/docs/api/1.1/get/help/languages
help.lisp (file)
standard-object (class)
:name
name (generic function)
(setf name) (generic function)
:code
code (generic function)
(setf code) (generic function)
:status
status (generic function)
(setf status) (generic function)
Twitter object containing Locational data. Used for the Places & Geo API.
According to spec https://dev.twitter.com/docs/platform-objects/places
location.lisp (file)
standard-object (class)
:name
name (generic function)
(setf name) (generic function)
:full-name
full-name (generic function)