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.

40 KiB

notifications Module


Table of Contents

  1. <mastodon-account>
  2. <mastodon-application>
  3. <mastodon-attachment>
  4. <mastodon-card>
  5. <mastodon-emoji>
  6. <mastodon-field>
  7. <mastodon-history>
  8. <mastodon-mention>
  9. <mastodon-meta-focus>
  10. <mastodon-meta-subtree>
  11. <mastodon-meta>
  12. <mastodon-notification>
  13. <mastodon-pagination-object>
  14. <mastodon-poll>
  15. <mastodon-status>
  16. <mastodon-tag>
  17. <mastodon-web-push-subscription-alerts>
  18. <mastodon-web-push-subscription>
  19. masto-account-acct
  20. masto-account-avatar
  21. masto-account-avatar-static
  22. masto-account-bot?
  23. masto-account-created-at
  24. masto-account-discoverable?
  25. masto-account-display-name
  26. masto-account-emojis
  27. masto-account-fields
  28. masto-account-followers-count
  29. masto-account-following-count
  30. masto-account-group?
  31. masto-account-header
  32. masto-account-header-static
  33. masto-account-id
  34. masto-account-last-status-at
  35. masto-account-locked?
  36. masto-account-moved
  37. masto-account-note
  38. masto-account-statuses-count
  39. masto-account-url
  40. masto-account-username
  41. masto-account?
  42. masto-application-name
  43. masto-application-website
  44. masto-application?
  45. masto-attachment-blurhash
  46. masto-attachment-description
  47. masto-attachment-id
  48. masto-attachment-meta
  49. masto-attachment-preview-url
  50. masto-attachment-remote-url
  51. masto-attachment-text-url
  52. masto-attachment-type
  53. masto-attachment-url
  54. masto-attachment?
  55. masto-card-author-name
  56. masto-card-author-url
  57. masto-card-description
  58. masto-card-height
  59. masto-card-html
  60. masto-card-image
  61. masto-card-provider-name
  62. masto-card-provider-url
  63. masto-card-title
  64. masto-card-type
  65. masto-card-url
  66. masto-card-width
  67. masto-card?
  68. masto-emoji-shortcode
  69. masto-emoji-static-url
  70. masto-emoji-url
  71. masto-emoji-visible-in-picker?
  72. masto-emoji?
  73. masto-field-name
  74. masto-field-value
  75. masto-field-verified-at
  76. masto-field?
  77. masto-history-accounts
  78. masto-history-day
  79. masto-history-uses
  80. masto-history?
  81. masto-mention-acct
  82. masto-mention-id
  83. masto-mention-url
  84. masto-mention-username
  85. masto-mention?
  86. masto-meta-focus
  87. masto-meta-focus-x
  88. masto-meta-focus-y
  89. masto-meta-focus?
  90. masto-meta-original
  91. masto-meta-small
  92. masto-meta-subtree-aspect
  93. masto-meta-subtree-bitrate
  94. masto-meta-subtree-duration
  95. masto-meta-subtree-frame-rate
  96. masto-meta-subtree-height
  97. masto-meta-subtree-size
  98. masto-meta-subtree-width
  99. masto-meta-subtree?
  100. masto-meta?
  101. masto-page-next
  102. masto-page-objects
  103. masto-page-prev
  104. masto-page?
  105. masto-poll-expired
  106. masto-poll-expires-at
  107. masto-poll-id
  108. masto-poll-multiple
  109. masto-poll-options
  110. masto-poll-voted
  111. masto-poll-votes-count
  112. masto-poll?
  113. masto-status-account
  114. masto-status-application
  115. masto-status-card
  116. masto-status-content
  117. masto-status-created-at
  118. masto-status-emojis
  119. masto-status-favorited
  120. masto-status-favorites-count
  121. masto-status-id
  122. masto-status-in-reply-to-account-id
  123. masto-status-in-reply-to-id
  124. masto-status-language
  125. masto-status-media-attachments
  126. masto-status-mentions
  127. masto-status-muted
  128. masto-status-pinned
  129. masto-status-poll
  130. masto-status-reblog-status
  131. masto-status-reblogged
  132. masto-status-reblogs-count
  133. masto-status-replies-count
  134. masto-status-sensitive
  135. masto-status-spoiler-text
  136. masto-status-tags
  137. masto-status-uri
  138. masto-status-url
  139. masto-status-visibility
  140. masto-status?
  141. masto-tag-history
  142. masto-tag-name
  143. masto-tag-url
  144. masto-tag?
  145. masto-web-push-create-subscription
  146. masto-web-push-delete-subscription
  147. masto-web-push-get-subscription
  148. masto-web-push-subscription-alerts
  149. masto-web-push-subscription-alerts-favorite
  150. masto-web-push-subscription-alerts-follow
  151. masto-web-push-subscription-alerts-mention
  152. masto-web-push-subscription-alerts-poll
  153. masto-web-push-subscription-alerts-reblog
  154. masto-web-push-subscription-alerts?
  155. masto-web-push-subscription-endpoint
  156. masto-web-push-subscription-id
  157. masto-web-push-subscription-server-key
  158. masto-web-push-subscription?
  159. masto-web-push-update-subscription
  160. masto-notification-account
  161. masto-notification-create-at
  162. masto-notification-id
  163. masto-notification-status
  164. masto-notification-type
  165. masto-notification?
  166. masto-notification-dismiss
  167. masto-notification-get
  168. masto-notifications-all
  169. masto-notifications-all-clear


<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-application>

Summary

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

Record Fields

name
website


<mastodon-attachment>

Summary

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

Record Fields

id
type
url
remoteURL
previewURL
textURL
meta
description
blurhash


<mastodon-card>

Summary

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

Record Fields

url
title
description
image
type
authorName
authorURL
providerName
providerURL
html
width
height


<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-history>

Summary

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

Record Fields

day
uses
accounts


<mastodon-mention>

Summary

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

Record Fields

url
username
acct
id


<mastodon-meta-focus>

Summary

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

Record Fields

x
y


<mastodon-meta-subtree>

Summary

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

Record Fields

width
height
size
aspect
frameRate
duration
bitrate


<mastodon-meta>

Summary

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

Record Fields

small
original
focus


<mastodon-notification>

Summary

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

Record Fields

id
type
createdAt
account
status


<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


<mastodon-poll>

Summary

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

Record Fields

id
expiresAt
expired
multiple
votesCount
options
voted


<mastodon-status>

Summary

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

Record Fields

id
uri
url
account
inReplyToID
inReplyToAccountID
reblogStatus
content
createdAt
emojis
repliesCount
reblogsCount
favoritesCount
reblogged
favorited
muted
bookmarked
sensitive
spoilerText
visibility
mediaAttachments
mentions
tags
card
poll
application
language
pinned


<mastodon-tag>

Summary

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

Record Fields

name
url
history


<mastodon-web-push-subscription-alerts>

Summary

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

Record Fields

poll
mention
reblog
favorite
follow


<mastodon-web-push-subscription>

Summary

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

Record Fields

id
endpoint
serverKey
alerts


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-application-name

Summary

#f

Parameters

#f03c15 s


masto-application-website

Summary

#f

Parameters

#f03c15 s


masto-application?

Summary

#f

Parameters

#f03c15 obj


masto-attachment-blurhash

Summary

#f

Parameters

#f03c15 s


masto-attachment-description

Summary

#f

Parameters

#f03c15 s


masto-attachment-id

Summary

#f

Parameters

#f03c15 s


masto-attachment-meta

Summary

#f

Parameters

#f03c15 s


masto-attachment-preview-url

Summary

#f

Parameters

#f03c15 s


masto-attachment-remote-url

Summary

#f

Parameters

#f03c15 s


masto-attachment-text-url

Summary

#f

Parameters

#f03c15 s


masto-attachment-type

Summary

#f

Parameters

#f03c15 s


masto-attachment-url

Summary

#f

Parameters

#f03c15 s


masto-attachment?

Summary

#f

Parameters

#f03c15 obj


masto-card-author-name

Summary

#f

Parameters

#f03c15 s


masto-card-author-url

Summary

#f

Parameters

#f03c15 s


masto-card-description

Summary

#f

Parameters

#f03c15 s


masto-card-height

Summary

#f

Parameters

#f03c15 s


masto-card-html

Summary

#f

Parameters

#f03c15 s


masto-card-image

Summary

#f

Parameters

#f03c15 s


masto-card-provider-name

Summary

#f

Parameters

#f03c15 s


masto-card-provider-url

Summary

#f

Parameters

#f03c15 s


masto-card-title

Summary

#f

Parameters

#f03c15 s


masto-card-type

Summary

#f

Parameters

#f03c15 s


masto-card-url

Summary

#f

Parameters

#f03c15 s


masto-card-width

Summary

#f

Parameters

#f03c15 s


masto-card?

Summary

#f

Parameters

#f03c15 obj


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-history-accounts

Summary

#f

Parameters

#f03c15 s


masto-history-day

Summary

#f

Parameters

#f03c15 s


masto-history-uses

Summary

#f

Parameters

#f03c15 s


masto-history?

Summary

#f

Parameters

#f03c15 obj


masto-mention-acct

Summary

#f

Parameters

#f03c15 s


masto-mention-id

Summary

#f

Parameters

#f03c15 s


masto-mention-url

Summary

#f

Parameters

#f03c15 s


masto-mention-username

Summary

#f

Parameters

#f03c15 s


masto-mention?

Summary

#f

Parameters

#f03c15 obj


masto-meta-focus

Summary

#f

Parameters

#f03c15 s


masto-meta-focus-x

Summary

#f

Parameters

#f03c15 s


masto-meta-focus-y

Summary

#f

Parameters

#f03c15 s


masto-meta-focus?

Summary

#f

Parameters

#f03c15 obj


masto-meta-original

Summary

#f

Parameters

#f03c15 s


masto-meta-small

Summary

#f

Parameters

#f03c15 s


masto-meta-subtree-aspect

Summary

#f

Parameters

#f03c15 s


masto-meta-subtree-bitrate

Summary

#f

Parameters

#f03c15 s


masto-meta-subtree-duration

Summary

#f

Parameters

#f03c15 s


masto-meta-subtree-frame-rate

Summary

#f

Parameters

#f03c15 s


masto-meta-subtree-height

Summary

#f

Parameters

#f03c15 s


masto-meta-subtree-size

Summary

#f

Parameters

#f03c15 s


masto-meta-subtree-width

Summary

#f

Parameters

#f03c15 s


masto-meta-subtree?

Summary

#f

Parameters

#f03c15 obj


masto-meta?

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-poll-expired

Summary

#f

Parameters

#f03c15 s


masto-poll-expires-at

Summary

#f

Parameters

#f03c15 s


masto-poll-id

Summary

#f

Parameters

#f03c15 s


masto-poll-multiple

Summary

#f

Parameters

#f03c15 s


masto-poll-options

Summary

#f

Parameters

#f03c15 s


masto-poll-voted

Summary

#f

Parameters

#f03c15 s


masto-poll-votes-count

Summary

#f

Parameters

#f03c15 s


masto-poll?

Summary

#f

Parameters

#f03c15 obj


masto-status-account

Summary

#f

Parameters

#f03c15 s


masto-status-application

Summary

#f

Parameters

#f03c15 s


masto-status-card

Summary

#f

Parameters

#f03c15 s


masto-status-content

Summary

#f

Parameters

#f03c15 s


masto-status-created-at

Summary

#f

Parameters

#f03c15 s


masto-status-emojis

Summary

#f

Parameters

#f03c15 s


masto-status-favorited

Summary

#f

Parameters

#f03c15 s


masto-status-favorites-count

Summary

#f

Parameters

#f03c15 s


masto-status-id

Summary

#f

Parameters

#f03c15 s


masto-status-in-reply-to-account-id

Summary

#f

Parameters

#f03c15 s


masto-status-in-reply-to-id

Summary

#f

Parameters

#f03c15 s


masto-status-language

Summary

#f

Parameters

#f03c15 s


masto-status-media-attachments

Summary

#f

Parameters

#f03c15 s


masto-status-mentions

Summary

#f

Parameters

#f03c15 s


masto-status-muted

Summary

#f

Parameters

#f03c15 s


masto-status-pinned

Summary

#f

Parameters

#f03c15 s


masto-status-poll

Summary

#f

Parameters

#f03c15 s


masto-status-reblog-status

Summary

#f

Parameters

#f03c15 s


masto-status-reblogged

Summary

#f

Parameters

#f03c15 s


masto-status-reblogs-count

Summary

#f

Parameters

#f03c15 s


masto-status-replies-count

Summary

#f

Parameters

#f03c15 s


masto-status-sensitive

Summary

#f

Parameters

#f03c15 s


masto-status-spoiler-text

Summary

#f

Parameters

#f03c15 s


masto-status-tags

Summary

#f

Parameters

#f03c15 s


masto-status-uri

Summary

#f

Parameters

#f03c15 s


masto-status-url

Summary

#f

Parameters

#f03c15 s


masto-status-visibility

Summary

#f

Parameters

#f03c15 s


masto-status?

Summary

#f

Parameters

#f03c15 obj


masto-tag-history

Summary

#f

Parameters

#f03c15 s


masto-tag-name

Summary

#f

Parameters

#f03c15 s


masto-tag-url

Summary

#f

Parameters

#f03c15 s


masto-tag?

Summary

#f

Parameters

#f03c15 obj


masto-web-push-create-subscription

Summary

Add a Web Push API subscription to receive notifications for the user tied to mastoApp. Each access token can have one push subscription. If you create a new subscription, the old subscription is deleted.

subscriptionEndpoint is the endpoint URL that's called when a notification event occurs. subscriptionEndpoint can be a string or a uri object.

subscriptionKeysP256dh is the user agent public key. Base64 encoded string of public key of ECDH key using prime256v1 curve.

subscriptionKeysAuth is the auth secret. Base64 encoded string of 16 bytes of random data.

dataAlertsFollow is a boolean of whether to receive follow notifications.
dataAlertsFavorite is a boolean of whether to receive favourite notifications.
dataAlertsReblog is a boolean of whether to receive reblog notifications.
dataAlertsMention is a boolean of whether to receive mention notifications.
dataAlertsPoll is a boolean of whether to receive poll notifications.

This function returns a <mastodon-web-push-subscription>.

Find the original documentation here.

Parameters

#f03c15 mastoApp
#f03c15 subscriptionEndpoint
#f03c15 subscriptionKeysP256dh
#f03c15 subscriptionKeysAuth
#1589F0 #:dataAlertsFollow (argument position 5)
#1589F0 #:dataAlertsFavorite (argument position 6)
#1589F0 #:dataAlertsReblog (argument position 7)
#1589F0 #:dataAlertsMention (argument position 8)
#1589F0 #:dataAlertsPoll (argument position 9)


masto-web-push-delete-subscription

Summary

Delete the current subscription associated with the access token tied to mastoApp.

This function, if successful, returns #t.

Find the original documentation here.

Parameters

#f03c15 mastoApp


masto-web-push-get-subscription

Summary

Get the current subscription associated with the access token tied to mastoApp.

A <mastodon-web-push-subscription> is returned.

Find the original documentation here.

Parameters

#f03c15 mastoApp


masto-web-push-subscription-alerts

Summary

#f

Parameters

#f03c15 s


masto-web-push-subscription-alerts-favorite

Summary

#f

Parameters

#f03c15 s


masto-web-push-subscription-alerts-follow

Summary

#f

Parameters

#f03c15 s


masto-web-push-subscription-alerts-mention

Summary

#f

Parameters

#f03c15 s


masto-web-push-subscription-alerts-poll

Summary

#f

Parameters

#f03c15 s


masto-web-push-subscription-alerts-reblog

Summary

#f

Parameters

#f03c15 s


masto-web-push-subscription-alerts?

Summary

#f

Parameters

#f03c15 obj


masto-web-push-subscription-endpoint

Summary

#f

Parameters

#f03c15 s


masto-web-push-subscription-id

Summary

#f

Parameters

#f03c15 s


masto-web-push-subscription-server-key

Summary

#f

Parameters

#f03c15 s


masto-web-push-subscription?

Summary

#f

Parameters

#f03c15 obj


masto-web-push-update-subscription

Summary

Update the current subscription associated with the access token tied to mastoApp.

dataAlertsFollow is a boolean of whether to receive follow notifications.
dataAlertsFavorite is a boolean of whether to receive favourite notifications.
dataAlertsReblog is a boolean of whether to receive reblog notifications.
dataAlertsMention is a boolean of whether to receive mention notifications.
dataAlertsPoll is a boolean of whether to receive poll notifications.

A <mastodon-web-push-subscription> is returned.

Find the original documentation here.

Parameters

#f03c15 mastoApp
#1589F0 #:dataAlertsFollow (argument position 2)
#1589F0 #:dataAlertsFavorite (argument position 3)
#1589F0 #:dataAlertsReblog (argument position 4)
#1589F0 #:dataAlertsMention (argument position 5)
#1589F0 #:dataAlertsPoll (argument position 6)


masto-notification-account

Summary

#f

Parameters

#f03c15 s


masto-notification-create-at

Summary

#f

Parameters

#f03c15 s


masto-notification-id

Summary

#f

Parameters

#f03c15 s


masto-notification-status

Summary

#f

Parameters

#f03c15 s


masto-notification-type

Summary

#f

Parameters

#f03c15 s


masto-notification?

Summary

#f

Parameters

#f03c15 obj


masto-notification-dismiss

Summary

Dismiss a specific notification from the server for the user tied to mastoApp.

This function, if successful, returns #t.

Find the original documentation here.

Parameters

#f03c15 mastoApp
#f03c15 notificationID


masto-notification-get

Summary

Get a notification with the ID notificationID for the user tied to mastoApp.

A <mastodon-notification> is returned.

Find the original documentation here.

Parameters

#f03c15 mastoApp
#f03c15 notificationID


masto-notifications-all

Summary

Retrieve all notifications associated with the user tied to mastoApp.

maxID will result in returning results older than this ID.
sinceID will result in returning results newer than this ID.
minID will result in returning results immediately newer than this ID.

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

Specifying accountID will only return notifications from the said account.

A <mastodon-pagination-object> is returned, consisting of the <mastodon-notification>s that the user has blocked.

Find the original documentation here.

Parameters

#f03c15 mastoApp
#1589F0 #:maxID (argument position 2)
#1589F0 #:sinceID (argument position 3)
#1589F0 #:minID (argument position 4)
#1589F0 #:limit (argument position 5)
#1589F0 #:excludeTypes (argument position 6)
#1589F0 #:accountID (argument position 7)


masto-notifications-all-clear

Summary

Dismiss all notifications from the server for the user tied to mastoApp.

This function, if successful, returns #t.

Find the original documentation here.

Parameters

#f03c15 mastoApp