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.

5.9 KiB

filters Module


Table of Contents

  1. <mastodon-filter>
  2. masto-filter-context
  3. masto-filter-expires-at
  4. masto-filter-id
  5. masto-filter-irreversible
  6. masto-filter-phrase
  7. masto-filter-whole-word
  8. masto-filter?
  9. masto-filter-create
  10. masto-filter-delete
  11. masto-filter-get
  12. masto-filter-update
  13. masto-filters-all


<mastodon-filter>

Summary

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

Record Fields

id
phrase
context
expiresAt
irreversible
wholeWord


masto-filter-context

Summary

#f

Parameters

#f03c15 s


masto-filter-expires-at

Summary

#f

Parameters

#f03c15 s


masto-filter-id

Summary

#f

Parameters

#f03c15 s


masto-filter-irreversible

Summary

#f

Parameters

#f03c15 s


masto-filter-phrase

Summary

#f

Parameters

#f03c15 s


masto-filter-whole-word

Summary

#f

Parameters

#f03c15 s


masto-filter?

Summary

#f

Parameters

#f03c15 obj


masto-filter-create

Summary

#f

Parameters

#f03c15 mastoApp
#1589F0 #:filter (argument position 2)
#1589F0 #:phrase (argument position 3)
#1589F0 #:context (argument position 4)
#1589F0 #:expiresIn (argument position 5)
#1589F0 #:irreversible (argument position 6)
#1589F0 #:wholeWord (argument position 7)


masto-filter-delete

Summary

Delete a particular filter that'd been created by the user tied to mastoApp.

filterID refers to the ID of the filter that you wish to delete.

If successful, this function will return #t.

Find the original documentation here.

Parameters

#f03c15 mastoApp
#f03c15 filterID


masto-filter-get

Summary

Retrieve a particular filter created by the user tied to mastoApp.

filterID refers to the ID of the filter that you wish to retrieve.

This function will return a <mastodon-filter>.

Find the original documentation here.

Parameters

#f03c15 mastoApp
#f03c15 filterID


masto-filter-update

Summary

Update a particular filter created by the user tied to mastoApp.

masto-filter-update allows you to pass a <mastodon-filter> with #:filter or to provide the details of the filter with the other remaining keywords.

if filter is provided, it will be used as a representation of the details of the filter you with to update and the remaining keywords will be ignored.

context must be a valid filter context.

Both phrase and context, if not using filter, are required; all other keyword arguments are optional.

expiresIn must be a SRFI-19 date or time object or a number representing the number of seconds until expiry; if a date object is provided, the number of seconds from the current time will be calculated and used.

This function will return a <mastodon-filter> containing the updated details.

Find the original documentation here.

Parameters

#f03c15 mastoApp
#1589F0 #:filter (argument position 2)
#1589F0 #:id (argument position 3)
#1589F0 #:phrase (argument position 4)
#1589F0 #:context (argument position 5)
#1589F0 #:expiresIn (argument position 6)
#1589F0 #:irreversible (argument position 7)
#1589F0 #:wholeWord (argument position 8)


masto-filters-all

Summary

Retrieve all filters created by the user tied to mastoApp.

This function will return a list of <mastodon-filter>s.

Find the original documentation here.

Parameters

#f03c15 mastoApp