A client library implementing the full v1 REST API protocol for Mastodon in Guile
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

14 KiB

lists Module


Table of Contents

  1. <mastodon-account>
  2. <mastodon-emoji>
  3. <mastodon-field>
  4. <mastodon-list>
  5. <mastodon-pagination-object>
  6. masto-account-acct
  7. masto-account-avatar
  8. masto-account-avatar-static
  9. masto-account-bot?
  10. masto-account-created-at
  11. masto-account-discoverable?
  12. masto-account-display-name
  13. masto-account-emojis
  14. masto-account-fields
  15. masto-account-followers-count
  16. masto-account-following-count
  17. masto-account-group?
  18. masto-account-header
  19. masto-account-header-static
  20. masto-account-id
  21. masto-account-last-status-at
  22. masto-account-locked?
  23. masto-account-moved
  24. masto-account-note
  25. masto-account-statuses-count
  26. masto-account-url
  27. masto-account-username
  28. masto-account?
  29. masto-accounts-by-list
  30. masto-emoji-shortcode
  31. masto-emoji-static-url
  32. masto-emoji-url
  33. masto-emoji-visible-in-picker?
  34. masto-emoji?
  35. masto-field-name
  36. masto-field-value
  37. masto-field-verified-at
  38. masto-field?
  39. masto-page-next
  40. masto-page-objects
  41. masto-page-prev
  42. masto-page?
  43. masto-list-id
  44. masto-list-title
  45. masto-list?
  46. masto-list-add-account
  47. masto-list-create
  48. masto-list-delete
  49. masto-list-delete-account
  50. masto-list-get
  51. masto-list-update
  52. masto-lists-all
  53. masto-lists-by-account


<mastodon-account>

Summary

A record object that can be returned by an API call.

Record Fields

id
username
acct
displayName
locked
bot
discoverable
group
createdAt
followersCount
followingCount
statusesCount
lastStatusAt
note
url
avatar
avatarStatic
header
headerStatic
emojis
moved
fields


<mastodon-emoji>

Summary

A record object that can be returned by an API call.

Record Fields

shortcode
staticURL
url
visibleInPicker


<mastodon-field>

Summary

A record object that can be returned by an API call.

Record Fields

name
value
verifiedAt


<mastodon-list>

Summary

A record object that can be returned by an API call.

Record Fields

id
title


<mastodon-pagination-object>

Summary

A record object that can be returned by an API call.

Record Fields

objectCollection
prevURL
prevPage
nextURL
nextPage
http-call
generate-fn


masto-account-acct

Summary

#f

Parameters

#f03c15 s


masto-account-avatar

Summary

#f

Parameters

#f03c15 s


masto-account-avatar-static

Summary

#f

Parameters

#f03c15 s


masto-account-bot?

Summary

#f

Parameters

#f03c15 s


masto-account-created-at

Summary

#f

Parameters

#f03c15 s


masto-account-discoverable?

Summary

#f

Parameters

#f03c15 s


masto-account-display-name

Summary

#f

Parameters

#f03c15 s


masto-account-emojis

Summary

#f

Parameters

#f03c15 s


masto-account-fields

Summary

#f

Parameters

#f03c15 s


masto-account-followers-count

Summary

#f

Parameters

#f03c15 s


masto-account-following-count

Summary

#f

Parameters

#f03c15 s


masto-account-group?

Summary

#f

Parameters

#f03c15 s


masto-account-header

Summary

#f

Parameters

#f03c15 s


masto-account-header-static

Summary

#f

Parameters

#f03c15 s


masto-account-id

Summary

#f

Parameters

#f03c15 s


masto-account-last-status-at

Summary

#f

Parameters

#f03c15 s


masto-account-locked?

Summary

#f

Parameters

#f03c15 s


masto-account-moved

Summary

#f

Parameters

#f03c15 s


masto-account-note

Summary

#f

Parameters

#f03c15 s


masto-account-statuses-count

Summary

#f

Parameters

#f03c15 s


masto-account-url

Summary

#f

Parameters

#f03c15 s


masto-account-username

Summary

#f

Parameters

#f03c15 s


masto-account?

Summary

#f

Parameters

#f03c15 obj


masto-accounts-by-list

Summary

Retrieve all user accounts that are in a list created by the user tied to mastoApp.

If no limit value is provided, the value 40 is used.

listID refers to the list, created by the user, that you want to get accounts from.

A <mastodon-pagination-object> is returned, consisting of the <mastodon-account>s that are in the specified list.

Find the original documentation here.

Parameters

#f03c15 mastoApp
#f03c15 listID
#c5f015 [limit]


masto-emoji-shortcode

Summary

#f

Parameters

#f03c15 s


masto-emoji-static-url

Summary

#f

Parameters

#f03c15 s


masto-emoji-url

Summary

#f

Parameters

#f03c15 s


masto-emoji-visible-in-picker?

Summary

#f

Parameters

#f03c15 s


masto-emoji?

Summary

#f

Parameters

#f03c15 obj


masto-field-name

Summary

#f

Parameters

#f03c15 s


masto-field-value

Summary

#f

Parameters

#f03c15 s


masto-field-verified-at

Summary

#f

Parameters

#f03c15 s


masto-field?

Summary

#f

Parameters

#f03c15 obj


masto-page-next

Summary

#f

Parameters

#f03c15 mastoApp
#f03c15 page


masto-page-objects

Summary

#f

Parameters

#f03c15 s


masto-page-prev

Summary

#f

Parameters

#f03c15 mastoApp
#f03c15 page


masto-page?

Summary

#f

Parameters

#f03c15 obj


masto-list-id

Summary

#f

Parameters

#f03c15 s


masto-list-title

Summary

#f

Parameters

#f03c15 s


masto-list?

Summary

#f

Parameters

#f03c15 obj


masto-list-add-account

Summary

Add an account(s) to the list which has the ID listID for the user tied to mastoApp.

accountIDs should be a list of Fediverse account IDs.

This function, if successful, returns #t.

Find the original documentation here.

Parameters

#f03c15 mastoApp
#f03c15 listID
#f03c15 accountIDs


masto-list-create

Summary

Create a list for the user tied to mastoApp with the title title.

This function returns the <mastodon-list> you just created.

Find the original documentation here.

Parameters

#f03c15 mastoApp
#f03c15 title


masto-list-delete

Summary

Delete the list for the user tied to mastoApp which has the ID listID.

This function, if successful, returns #t.

Find the original documentation here.

Parameters

#f03c15 mastoApp
#f03c15 listID


masto-list-delete-account

Summary

Delete an account(s) from the list which has the ID listID for the user tied to mastoApp.

accountIDs should be a list of Fediverse account IDs.

This function, if successful, returns #t.

Find the original documentation here.

Parameters

#f03c15 mastoApp
#f03c15 listID
#f03c15 accountIDs


masto-list-get

Summary

Retrieve the list, created by the user tied to mastoApp, that has the list ID listID.

This function returns a <mastodon-list>, corresponding to the listID.

Find the original documentation here.

Parameters

#f03c15 mastoApp
#f03c15 listID


masto-list-update

Summary

Update the title, of a list for the user tied to mastoApp and which has the ID listID, to title.

This function returns the <mastodon-list> you just updated, with the updates.

Find the original documentation here.

Parameters

#f03c15 mastoApp
#f03c15 listID
#f03c15 title


masto-lists-all

Summary

Retrieve all lists for the user tied to mastoApp.

This function returns a (Scheme) list of <mastodon-list>s that the user has created.

Find the original documentation here.

Parameters

#f03c15 mastoApp


masto-lists-by-account

Summary

Retrieve all lists created by the user tied to mastoApp that contain Fediverse users that have the account ID accountID.

This function returns a (Scheme) list of <mastodon-list>s.

Find the original documentation within this page.

Parameters

#f03c15 mastoApp
#f03c15 accountID