Next: Introduction, Previous: (dir), Up: (dir) [Contents][Index]
This is the cl-reddit Reference Manual, version 0.1, generated automatically by Declt version 2.4 "Will Decker" on Wed Jun 20 11:21:13 2018 GMT+0.
• Introduction: | What cl-reddit 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 |
#CL-REDDIT
Common lisp reddit api wrapper
cl-reddit is now included in quicklisp
* (ql:quickload "cl-reddit")
Create user and login and view user modhash
CL-REDDIT> (defvar u (api-login :username "AzureDiamond" :password "hunter2"))
CL-REDDIT> (user-modhash u)
CL-REDDIT> "393eioafja78iafjioiwoijhgnhn223jik9rjfoq87fnbh13j"
Search with keywords, loop through results
CL-REDDIT> (defvar lst (get-search "Lance Armstrong"))
CL-REDDIT> (loop for l in lst do (format t "~a:~a~%" (link-score l) (link-title l)))
Search can take several optional parameters, to search restricted to a particular subreddit
CL-REDDIT> (defvar lst (get-search "Lance Armstrong" :sub "funny" :restrict-sr t))
All key params are required for api-* functions generated from def-post-api macro.
(defun api-login (&key username password)
"Login user username with password. Returns a User object with modhash,cookie set.")
(defun api-subscribe (user &key id action))
"Sub or unsub from subreddit sr for user usr. Action can be :sub or :unsub")
(defun api-comment (user &key id text)
"Comments text on id with user usr.")
(defun api-editusrtext (user &key id text)
"Edit user text on id with user usr.")
(defun api-vote (user &key id vote)
"Vote direction :up :down :unvote for thing with id with user.")
(defun api-save (user &key id)
"Save thing with id.")
(defun api-unsave (user &key id)
"Unsave thing with id.")
(defun api-report (user &key id)
"Report thing with id.")
(defun api-marknsfw (user &key id)
"Mark thing with id as nsfw.")
(defun api-hide (user &key id)
"Hide thing with id.")
(defun api-unhide (user &key id)
"Unhide thing with id.")
(defun api-del (user &key id)
"Delete thing with id.")
(defun api-block (user &key id)
"Block thing with id.")
(defun api-read_message (user &key id)
"Read message with id.")
(defun api-unread_message (user &key id)
"Unread message with id.")
(defun api-approve (user &key id)
"Approve thing with id.")
(defun api-leavecontributor (user &key id)
"Self removal as moderator of thing with id.")
(defun api-leavemoderator (user &key id)
"Remove as moderator of subreddit with id.")
(defun api-remove (user &key id spam)
"Remove thing with id. Is-spam t if spam, nil if not.")
(defun api-setflairenabled (user &key flair-enabled)
"Enable/disable flair.")
(defun get-user (r-user &optional user)
"Get /user/<r-user>.json. Optional user.")
(defun get-about-user (about-user &optional usr)
"Get /user/<about-user>/about.json. Optional user.")
(defun get-message (user where)
"Gets messages from inbox for user user.")
(defun get-subscribed (user)
"Gets subscribed subreddits")
(defun get-comments (id user &key article comment context depth limit sort)
"Gets comments for link id in subreddit sr.")
(defun get-reddit (&optional user)
"Gets json data for reddit home page. Optional user.")
(defun get-subreddit (sub &optional user)
"Gets json data for subreddit sub. Optional user usr.")
(defun get-subreddit-new (sub &optional user)
"Gets json data for /r/<sub>/new. Optional user.")
(defun get-subreddit-top (sub &optional user)
"Gets json data for top posts in subreddit sub. Optional user user.")
(defun get-subreddit-about (sub &optional user)
"Gets r/<sub>/about.json. Returns Subreddit object about sub. Optional user.")
(defun get-search (query &key user after before count limit restrict-sr show sort syntax time target sub)
"Search for query.")
See cl-reddit.lisp for full api.
Lots of stuff could be improved or extended, contributers are welcome! Here are a few ideas, feel free to work on any (or all) of these.
Request throttling - Basically right now the api will let you send as many requests as you want, which can return errors if too many get sent in a short time. It would be nice if the api could handle this and either resend after a timeout or wait to send the request if too many have been sent in a short time.
Async api - The basic api is synchronous, it could be used to build async requests but having an async interface along with the basic one could be useful.
High level api - The current api is pretty low level, mapping to the reddit api, having something that works at a higher level would make this library easier to use. I haven't though much about what this would look like so ideas are welcome.
Error handling - Currently there isn't anything, so if a api request fails for some reason the result is probably a nil value.
Better return types - Some of the methods return a hash table or a listing, see (cl-reddit:get-user), which doesn't always make sense.
Use OAuth - See https://github.com/jperson/cl-reddit/issues/8
Tests - It would be nice to have a test suite with lots of api coverage, maybe using a unit test framework.
More documentation - What project couldn't use this?
Cool apps that use this library so it gets more exposure.
If you have any opinions/ideas on how to make this thing better please share!
Next: Files, Previous: Introduction, Up: Top [Contents][Index]
The main system appears first, followed by any subsystem dependency.
• The cl-reddit system: |
Jason Person
BSD
Reddit client api library
0.1
cl-reddit.asd (file)
Files are sorted by type and then listed depth-first from the systems components trees.
• Lisp files: |
Next: The cl-reddit/package<dot>lisp file, Previous: Lisp files, Up: Lisp files [Contents][Index]
cl-reddit.asd
cl-reddit (system)
Next: The cl-reddit/globals<dot>lisp file, Previous: The cl-reddit<dot>asd file, Up: Lisp files [Contents][Index]
Next: The cl-reddit/util<dot>lisp file, Previous: The cl-reddit/package<dot>lisp file, Up: Lisp files [Contents][Index]
package.lisp (file)
cl-reddit (system)
globals.lisp
*user-agent* (special variable)
Next: The cl-reddit/url<dot>lisp file, Previous: The cl-reddit/globals<dot>lisp file, Up: Lisp files [Contents][Index]
globals.lisp (file)
cl-reddit (system)
util.lisp
Next: The cl-reddit/datatypes<dot>lisp file, Previous: The cl-reddit/util<dot>lisp file, Up: Lisp files [Contents][Index]
util.lisp (file)
cl-reddit (system)
url.lisp
Next: The cl-reddit/cl-reddit<dot>lisp file, Previous: The cl-reddit/url<dot>lisp file, Up: Lisp files [Contents][Index]
url.lisp (file)
cl-reddit (system)
datatypes.lisp
Previous: The cl-reddit/datatypes<dot>lisp file, Up: Lisp files [Contents][Index]
datatypes.lisp (file)
cl-reddit (system)
cl-reddit.lisp
Next: Definitions, Previous: Files, Up: Top [Contents][Index]
Packages are listed by definition order.
• The cl-reddit package: |
Reddit api wrapper.
package.lisp (file)
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 classes: |
Next: Exported macros, Previous: Exported definitions, Up: Exported definitions [Contents][Index]
globals.lisp (file)
Next: Exported functions, Previous: Exported special variables, Up: Exported definitions [Contents][Index]
Does ’body’ with logged-in user usr. Logins in user if not logged-in.
Next: Exported generic functions, Previous: Exported macros, Up: Exported definitions [Contents][Index]
cl-reddit.lisp (file)
cl-reddit.lisp (file)
cl-reddit.lisp (file)
cl-reddit.lisp (file)
cl-reddit.lisp (file)
cl-reddit.lisp (file)
cl-reddit.lisp (file)
Login user username with password. Returns a User object with modhash,cookie set.
cl-reddit.lisp (file)
cl-reddit.lisp (file)
Get info for user usr. Returns user data.
cl-reddit.lisp (file)
cl-reddit.lisp (file)
cl-reddit.lisp (file)
cl-reddit.lisp (file)
cl-reddit.lisp (file)
cl-reddit.lisp (file)
cl-reddit.lisp (file)
cl-reddit.lisp (file)
cl-reddit.lisp (file)
cl-reddit.lisp (file)
cl-reddit.lisp (file)
Get /user/<about-user>/about.json. Optional user user.
cl-reddit.lisp (file)
Gets comments for link id in subreddit sr.
cl-reddit.lisp (file)
Gets messages from inbox for user user. where can be one of ’inbox ’unread ’sent
cl-reddit.lisp (file)
Gets json data for reddit home page. Optional user.
cl-reddit.lisp (file)
Search for query.
cl-reddit.lisp (file)
Gets json data for subreddit sub. Optional user.
cl-reddit.lisp (file)
Gets r/<sub>/about.json. Returns Subreddit object about sub. Optional user usr.
cl-reddit.lisp (file)
Gets json data for /r/<sub>/new. Optional user.
cl-reddit.lisp (file)
Gets json data for top posts in subreddit sub. Optional user usr.
cl-reddit.lisp (file)
Gets subscribed subreddits
cl-reddit.lisp (file)
Get /user/<r-user>.json. Optional user user.
cl-reddit.lisp (file)
Make an instance of user class with username and password
Next: Exported classes, Previous: Exported functions, Up: Exported definitions [Contents][Index]
automatically generated reader method
datatypes.lisp (file)
automatically generated writer method
datatypes.lisp (file)
automatically generated reader method
datatypes.lisp (file)
automatically generated writer method
datatypes.lisp (file)
automatically generated reader method
datatypes.lisp (file)
automatically generated writer method
datatypes.lisp (file)
automatically generated reader method
datatypes.lisp (file)
automatically generated writer method
datatypes.lisp (file)
automatically generated reader method
datatypes.lisp (file)
automatically generated writer method
datatypes.lisp (file)
automatically generated reader method
datatypes.lisp (file)
automatically generated writer method
datatypes.lisp (file)
automatically generated reader method
datatypes.lisp (file)
automatically generated writer method
datatypes.lisp (file)
automatically generated reader method
datatypes.lisp (file)
automatically generated writer method
datatypes.lisp (file)
automatically generated reader method
datatypes.lisp (file)
automatically generated writer method
datatypes.lisp (file)
automatically generated reader method
datatypes.lisp (file)
automatically generated writer method
datatypes.lisp (file)
automatically generated reader method
datatypes.lisp (file)
automatically generated writer method
datatypes.lisp (file)
The account name of the poster
datatypes.lisp (file)
The css class of the author’s flair
datatypes.lisp (file)
The text of the author’s flair
datatypes.lisp (file)
The raw text
datatypes.lisp (file)
The formatted html text
datatypes.lisp (file)
The id of the comment.
datatypes.lisp (file)
automatically generated reader method
datatypes.lisp (file)
automatically generated writer method
datatypes.lisp (file)
The name of the comment.
datatypes.lisp (file)
automatically generated reader method
datatypes.lisp (file)
automatically generated writer method
datatypes.lisp (file)
Comment replies.
datatypes.lisp (file)
automatically generated reader method
datatypes.lisp (file)
automatically generated writer method
datatypes.lisp (file)
automatically generated reader method
datatypes.lisp (file)
automatically generated writer method
datatypes.lisp (file)
automatically generated reader method
datatypes.lisp (file)
automatically generated writer method
datatypes.lisp (file)
The account name of the poster
datatypes.lisp (file)
The css class of the author’s flair
datatypes.lisp (file)
The text of the author’s flair
datatypes.lisp (file)
The domain of this link
datatypes.lisp (file)
Indicates if link has been edited
datatypes.lisp (file)
True if the post is hidden by the logged in user. False if not logged in or not hidden
datatypes.lisp (file)
The id of this link
datatypes.lisp (file)
True if this link is a selfpost
datatypes.lisp (file)
unknown
datatypes.lisp (file)
unknown
datatypes.lisp (file)
The name of this link.
datatypes.lisp (file)
The number of comments that belong to this link
datatypes.lisp (file)
True if the post is taggeed as NSFW. Nil otherwise
datatypes.lisp (file)
Relative url of the permanent link for this link
datatypes.lisp (file)
True if this post is saved by the logged in user
datatypes.lisp (file)
The net-score of the link
datatypes.lisp (file)
The raw text
datatypes.lisp (file)
The formatted escaped html text
datatypes.lisp (file)
automatically generated reader method
datatypes.lisp (file)
automatically generated writer method
datatypes.lisp (file)
automatically generated reader method
datatypes.lisp (file)
automatically generated writer method
datatypes.lisp (file)
Full url to the thumbnail for this link
datatypes.lisp (file)
automatically generated reader method
datatypes.lisp (file)
automatically generated writer method
datatypes.lisp (file)
The link of this post
datatypes.lisp (file)
The fullname of the listing that follows after this page
datatypes.lisp (file)
The fullname of the listing that follows before this page
datatypes.lisp (file)
A list of things that this listing wraps
datatypes.lisp (file)
Modhash value for this listing
datatypes.lisp (file)
automatically generated reader method
datatypes.lisp (file)
automatically generated writer method
datatypes.lisp (file)
automatically generated reader method
datatypes.lisp (file)
automatically generated writer method
datatypes.lisp (file)
automatically generated reader method
datatypes.lisp (file)
automatically generated writer method
datatypes.lisp (file)
automatically generated reader method
datatypes.lisp (file)
automatically generated writer method
datatypes.lisp (file)
automatically generated reader method
datatypes.lisp (file)
automatically generated writer method
datatypes.lisp (file)
automatically generated reader method
datatypes.lisp (file)
automatically generated writer method
datatypes.lisp (file)
automatically generated reader method
datatypes.lisp (file)
automatically generated writer method
datatypes.lisp (file)
automatically generated reader method
datatypes.lisp (file)
automatically generated writer method
datatypes.lisp (file)
automatically generated reader method
datatypes.lisp (file)
automatically generated writer method
datatypes.lisp (file)
automatically generated reader method
datatypes.lisp (file)
automatically generated writer method
datatypes.lisp (file)
automatically generated reader method
datatypes.lisp (file)
automatically generated writer method
datatypes.lisp (file)
automatically generated reader method
datatypes.lisp (file)
automatically generated writer method
datatypes.lisp (file)
automatically generated reader method
datatypes.lisp (file)
automatically generated writer method
datatypes.lisp (file)
automatically generated reader method
datatypes.lisp (file)
automatically generated writer method
datatypes.lisp (file)
automatically generated reader method
datatypes.lisp (file)
automatically generated writer method
datatypes.lisp (file)
automatically generated reader method
datatypes.lisp (file)
automatically generated writer method
datatypes.lisp (file)
automatically generated reader method
datatypes.lisp (file)
automatically generated writer method
datatypes.lisp (file)
automatically generated reader method
datatypes.lisp (file)
automatically generated writer method
datatypes.lisp (file)
automatically generated reader method
datatypes.lisp (file)
automatically generated writer method
datatypes.lisp (file)
automatically generated reader method
datatypes.lisp (file)
automatically generated writer method
datatypes.lisp (file)
automatically generated reader method
datatypes.lisp (file)
automatically generated writer method
datatypes.lisp (file)
automatically generated reader method
datatypes.lisp (file)
automatically generated writer method
datatypes.lisp (file)
automatically generated reader method
datatypes.lisp (file)
automatically generated writer method
datatypes.lisp (file)
automatically generated reader method
datatypes.lisp (file)
automatically generated writer method
datatypes.lisp (file)
automatically generated reader method
datatypes.lisp (file)
automatically generated writer method
datatypes.lisp (file)
automatically generated reader method
datatypes.lisp (file)
automatically generated writer method
datatypes.lisp (file)
automatically generated reader method
datatypes.lisp (file)
automatically generated writer method
datatypes.lisp (file)
The number of users subscribed to this subreddit
datatypes.lisp (file)
automatically generated reader method
datatypes.lisp (file)
automatically generated writer method
datatypes.lisp (file)
The relative URL of the subreddit
datatypes.lisp (file)
Custom data structure
datatypes.lisp (file)
This item’s identifiler, e.g. 8xwlg
datatypes.lisp (file)
String identifier that denotes the object’s type
datatypes.lisp (file)
Fullname of comment, e.g. t1_c3v7f8u
datatypes.lisp (file)
automatically generated reader method
datatypes.lisp (file)
automatically generated writer method
datatypes.lisp (file)
automatically generated reader method
datatypes.lisp (file)
automatically generated writer method
datatypes.lisp (file)
automatically generated reader method
datatypes.lisp (file)
automatically generated writer method
datatypes.lisp (file)
automatically generated reader method
datatypes.lisp (file)
automatically generated writer method
datatypes.lisp (file)
automatically generated reader method
datatypes.lisp (file)
automatically generated writer method
datatypes.lisp (file)
The number of downvotes
datatypes.lisp (file)
True if liked by user, false if disliked, nil if user neutral
datatypes.lisp (file)
The number of upvotes
datatypes.lisp (file)
Previous: Exported generic functions, Up: Exported definitions [Contents][Index]
datatypes.lisp (file)
standard-object (class)
integer
:comment_karma
0
account-comment_karma (generic function)
(setf account-comment_karma) (generic function)
integer
:created
0
account-created (generic function)
(setf account-created) (generic function)
integer
:created_utc
0
account-created_utc (generic function)
(setf account-created_utc) (generic function)
boolean
:has_mail
account-has_mail (generic function)
(setf account-has_mail) (generic function)
boolean
:has_mod_mail
account-has_mod_mail (generic function)
(setf account-has_mod_mail) (generic function)
string
:id
""
account-id (generic function)
(setf account-id) (generic function)
boolean
:is_gold
account-is_gold (generic function)
(setf account-is_gold) (generic function)
boolean
:is_mod
account-is_mod (generic function)
(setf account-is_mod) (generic function)
integer
:link_karma
0
account-link_karma (generic function)
(setf account-link_karma) (generic function)
string
:modhash
""
account-modhash (generic function)
(setf account-modhash) (generic function)
string
:name
""
account-name (generic function)
(setf account-name) (generic function)
datatypes.lisp (file)
The id of the comment.
string
:id
""
comment-id (generic function)
(setf comment-id) (generic function)
The name of the comment.
string
:name
""
comment-name (generic function)
(setf comment-name) (generic function)
The account name of the poster
string
:author
comment-author (generic function)
(setf comment-author) (generic function)
The css class of the author’s flair
string
:author_flair_css_class
comment-author_flair_css_class (generic function)
(setf comment-author_flair_css_class) (generic function)
The text of the author’s flair
string
:author_flair_text
""
comment-author_flair_text (generic function)
(setf comment-author_flair_text) (generic function)
The raw text
string
:body
""
comment-body (generic function)
(setf comment-body) (generic function)
The formatted html text
string
:body_html
""
comment-body_html (generic function)
(setf comment-body_html) (generic function)
string
:link_id
""
comment-link_id (generic function)
(setf comment-link_id) (generic function)
string
:parent_id
""
comment-parent_id (generic function)
(setf comment-parent_id) (generic function)
string
:subreddit
""
comment-subreddit (generic function)
(setf comment-subreddit) (generic function)
string
:subreddit_id
""
comment-subreddit_id (generic function)
(setf comment-subreddit_id) (generic function)
Comment replies.
:replies
comment-replies (generic function)
(setf comment-replies) (generic function)
datatypes.lisp (file)
standard-object (class)
:created
0
created-created (generic function)
(setf created-created) (generic function)
:created_utc
0
created-created_utc (generic function)
(setf created-created_utc) (generic function)
datatypes.lisp (file)
The id of this link
string
:id
""
link-id (generic function)
(setf link-id) (generic function)
The name of this link.
string
:name
""
link-name (generic function)
(setf link-name) (generic function)
The account name of the poster
string
:author
""
link-author (generic function)
(setf link-author) (generic function)
The css class of the author’s flair
(or null string)
cl-reddit::author_flair_css_class
""
link-author_flair_css_class (generic function)
(setf link-author_flair_css_class) (generic function)
The text of the author’s flair
(or null string)
:author_flair_text
""
link-author_flair_text (generic function)
(setf link-author_flair_text) (generic function)
Probably always returns false
boolean
:clicked
link-clicked (generic function)
(setf link-clicked) (generic function)
The domain of this link
string
:domain
""
link-domain (generic function)
(setf link-domain) (generic function)
True if the post is hidden by the logged in user. False if not logged in or not hidden
boolean
:hidden
link-hidden (generic function)
(setf link-hidden) (generic function)
True if this link is a selfpost
boolean
:is_self
link-is_self (generic function)
(setf link-is_self) (generic function)
unknown
:media
link-media (generic function)
(setf link-media) (generic function)
unknown
:media_embed
link-media_embed (generic function)
(setf link-media_embed) (generic function)
The number of comments that belong to this link
integer
:num_comments
0
link-num_comments (generic function)
(setf link-num_comments) (generic function)
True if the post is taggeed as NSFW. Nil otherwise
boolean
:over_18
link-over_18 (generic function)
(setf link-over_18) (generic function)
Relative url of the permanent link for this link
string
:permalink
""
link-permalink (generic function)
(setf link-permalink) (generic function)
True if this post is saved by the logged in user
boolean
:saved
link-saved (generic function)
(setf link-saved) (generic function)
The net-score of the link
integer
:score
0
link-score (generic function)
(setf link-score) (generic function)
The raw text
string
:selftext
""
link-selftext (generic function)
(setf link-selftext) (generic function)
The formatted escaped html text
(or null string)
:selftext_html
""
link-selftext_html (generic function)
(setf link-selftext_html) (generic function)
string
:subreddit
""
link-subreddit (generic function)
(setf link-subreddit) (generic function)
string
:subreddit_id
""
link-subreddit_id (generic function)
(setf link-subreddit_id) (generic function)
Full url to the thumbnail for this link
string
:thumbnail
""
link-thumbnail (generic function)
(setf link-thumbnail) (generic function)
string
:title
""
link-title (generic function)
(setf link-title) (generic function)
The link of this post
string
:url
""
link-url (generic function)
(setf link-url) (generic function)
Indicates if link has been edited
(or boolean integer)
:edited
0
link-edited (generic function)
(setf link-edited) (generic function)
datatypes.lisp (file)
standard-object (class)
The fullname of the listing that follows before this page
(or null string)
:before
""
listing-before (generic function)
(setf listing-before) (generic function)
The fullname of the listing that follows after this page
(or null string)
:after
""
listing-after (generic function)
(setf listing-after) (generic function)
Modhash value for this listing
string
:modhash
""
listing-modhash (generic function)
(setf listing-modhash) (generic function)
A list of things that this listing wraps
:children
listing-children (generic function)
(setf listing-children) (generic function)
datatypes.lisp (file)
created (class)
string
:author
""
message-author (generic function)
(setf message-author) (generic function)
string
:body
""
message-body (generic function)
(setf message-body) (generic function)
string
:body_html
""
message-body_html (generic function)
(setf message-body_html) (generic function)
string
:context
""
message-context (generic function)
(setf message-context) (generic function)
:first_message
message-first_message (generic function)
(setf message-first_message) (generic function)
string
:name
""
message-name (generic function)
(setf message-name) (generic function)
boolean
:new
message-new (generic function)
(setf message-new) (generic function)
string
:parent_id
""
message-parent_id (generic function)
(setf message-parent_id) (generic function)
string
:replies
""
message-replies (generic function)
(setf message-replies) (generic function)
string
:subject
""
message-subject (generic function)
(setf message-subject) (generic function)
string
:subreddit
""
message-subreddit (generic function)
(setf message-subreddit) (generic function)
boolean
:was_comment
message-was_comment (generic function)
(setf message-was_comment) (generic function)
datatypes.lisp (file)
standard-object (class)
integer
:cnt
0
more-count (generic function)
(setf more-count) (generic function)
string
:parent_id
""
more-parent_id (generic function)
(setf more-parent_id) (generic function)
string
:id
""
more-id (generic function)
(setf more-id) (generic function)
string
:name
""
more-name (generic function)
(setf more-name) (generic function)
:children
more-children (generic function)
(setf more-children) (generic function)
datatypes.lisp (file)
created (class)
string
:name
""
subreddit-name (generic function)
(setf subreddit-name) (generic function)
string
:id
""
subreddit-id (generic function)
(setf subreddit-id) (generic function)
string
:display_name
""
subreddit-display_name (generic function)
(setf subreddit-display_name) (generic function)
The number of users subscribed to this subreddit
integer
:subscribers
0
subreddit-subscribers (generic function)
(setf subreddit-subscribers) (generic function)
list
:header_size
0
subreddit-header_size (generic function)
(setf subreddit-header_size) (generic function)
boolean
:over18
subreddit-over18 (generic function)
(setf subreddit-over18) (generic function)
integer
:accounts_active
0
subreddit-accounts_active (generic function)
(setf subreddit-accounts_active) (generic function)
string
:public_description
""
subreddit-public_description (generic function)
(setf subreddit-public_description) (generic function)
string
:description
""
subreddit-description (generic function)
(setf subreddit-description) (generic function)
string
:description_html
""
subreddit-description_html (generic function)
(setf subreddit-description_html) (generic function)
(or null string)
:header_title
""
subreddit-header_title (generic function)
(setf subreddit-header_title) (generic function)
string
:header_img
""
subreddit-header_img (generic function)
(setf subreddit-header_img) (generic function)
string
:title
""
subreddit-title (generic function)
(setf subreddit-title) (generic function)
The relative URL of the subreddit
string
:url
""
subreddit-url (generic function)
(setf subreddit-url) (generic function)
datatypes.lisp (file)
standard-object (class)
This item’s identifiler, e.g. 8xwlg
string
:id
""
thing-id (generic function)
(setf thing-id) (generic function)
Fullname of comment, e.g. t1_c3v7f8u
string
:name
""
thing-name (generic function)
(setf thing-name) (generic function)
String identifier that denotes the object’s type
string
:kind
""
thing-kind (generic function)
(setf thing-kind) (generic function)
Custom data structure
:data
thing-data (generic function)
(setf thing-data) (generic function)
datatypes.lisp (file)
standard-object (class)
:cookie
user-cookie (generic function)
(setf user-cookie) (generic function)
:password
user-password (generic function)
(setf user-password) (generic function)
:username
user-username (generic function)
(setf user-username) (generic function)
:modhash
user-modhash (generic function)
(setf user-modhash) (generic function)
:logged-in
user-logged-in (generic function)
(setf user-logged-in) (generic function)
datatypes.lisp (file)
standard-object (class)
The number of upvotes
integer
:ups
0
volatile-ups (generic function)
(setf volatile-ups) (generic function)
The number of downvotes
integer
:downs
0
volatile-downs (generic function)
(setf volatile-downs) (generic function)
True if liked by user, false if disliked, nil if user neutral
:likes
volatile-likes (generic function)
(setf volatile-likes) (generic function)
Previous: Exported definitions, Up: Definitions [Contents][Index]
• Internal special variables: | ||
• Internal macros: | ||
• Internal functions: | ||
• Internal generic functions: |
Next: Internal macros, Previous: Internal definitions, Up: Internal definitions [Contents][Index]
globals.lisp (file)
globals.lisp (file)
Next: Internal functions, Previous: Internal special variables, Up: Internal definitions [Contents][Index]
Defines generic post request
Used in cl-reddit.lisp when defining get-* fns.
Example expansion:
(param-push hello a "this’ll be in place of a")
=>
(PROGN
(WHEN A (PUSH ‘("this’ll be in place of a" ,@A) PARAMS))
(WHEN HELLO (PUSH ‘("hello" ,@HELLO) PARAMS)))
Next: Internal generic functions, Previous: Internal macros, Up: Internal definitions [Contents][Index]
cl-reddit.lisp (file)
datatypes.lisp (file)
cl-reddit.lisp (file)
cl-reddit.lisp (file)
cl-reddit.lisp (file)
Builds get param list from cons list ’((param . value) (param2 . value) ...)
datatypes.lisp (file)
Format a list of key arguments
Gets json data for url with options cookie-jar.
Gets listing of subreddits for user.
where can be one of ’subscriber ’moderator ’contributorfor.
cl-reddit.lisp (file)
Gets listing of subreddits for user. where can be one of ’new ’popular ’banned
cl-reddit.lisp (file)
Check if a username is available.
cl-reddit.lisp (file)
datatypes.lisp (file)
datatypes.lisp (file)
datatypes.lisp (file)
datatypes.lisp (file)
datatypes.lisp (file)
datatypes.lisp (file)
Send post request to url with params list.
Send post request to url with params list.
datatypes.lisp (file)
Convert the input symbol to the correct string for api call.
Previous: Internal functions, Up: Internal definitions [Contents][Index]
automatically generated reader method
datatypes.lisp (file)
automatically generated writer method
datatypes.lisp (file)
Probably always returns false
datatypes.lisp (file)
automatically generated reader method
datatypes.lisp (file)
automatically generated writer method
datatypes.lisp (file)
Previous: Definitions, Up: Top [Contents][Index]
• Concept index: | ||
• Function index: | ||
• Variable index: | ||
• Data type index: |
Next: Function index, Previous: Indexes, Up: Indexes [Contents][Index]
Jump to: | C F L |
---|
Jump to: | C F L |
---|
Next: Variable index, Previous: Concept index, Up: Indexes [Contents][Index]
Jump to: | %
(
A B C D E F G I L M P S T U V W |
---|
Jump to: | %
(
A B C D E F G I L M P S T U V W |
---|
Next: Data type index, Previous: Function index, Up: Indexes [Contents][Index]
Jump to: | *
A B C D E F H I K L M N O P R S T U W |
---|
Jump to: | *
A B C D E F H I K L M N O P R S T U W |
---|
Previous: Variable index, Up: Indexes [Contents][Index]
Jump to: | A C L M P S T U V |
---|
Jump to: | A C L M P S T U V |
---|