Documentation
¶
Index ¶
- type DeleteAnnouncement_Reaction
- type DeleteConversation
- type DeleteDomainBlock
- type DeleteFeaturedTag
- type DeleteFilter
- type DeleteFilter_Keyword
- type DeleteFilter_Status
- type DeleteFilter_V1
- type DeleteList
- type DeleteList_Accounts
- type DeleteProfile_Avatar
- type DeleteProfile_Header
- type DeleteScheduledStatus
- type DeleteStatus
- type DeleteSuggestion
- type GetAccount
- type GetAccount_FamiliarFollowers
- type GetAccount_FeaturedTags
- type GetAccount_Followers
- type GetAccount_Following
- type GetAccount_Lists
- type GetAccount_Lookup
- type GetAccount_Relationships
- type GetAccount_Search
- type GetAccount_Statuses
- type GetAccount_VerifyCredentials
- type GetAnnouncements
- type GetApplication_VerifyCredentials
- type GetBlocks
- type GetBookmarks
- type GetConversations
- type GetCustomEmojis
- type GetDirectory
- type GetDomainBlocks
- type GetEndorsements
- type GetFavourites
- type GetFeaturedTags
- type GetFeaturedTags_Suggestions
- type GetFilter
- type GetFilter_Keyword
- type GetFilter_Keywords
- type GetFilter_Status
- type GetFilter_Statuses
- type GetFilter_V1
- type GetFilters
- type GetFilters_V1
- type GetFollowRequests
- type GetFollowedTags
- type GetInstance
- type GetInstance_Activity
- type GetInstance_DomainBlocks
- type GetInstance_ExtendedDescription
- type GetInstance_Peers
- type GetInstance_Rules
- type GetInstance_V1
- type GetList
- type GetList_Accounts
- type GetLists
- type GetMarkers
- type GetMutes
- type GetNotification
- type GetNotifications
- type GetOAuth_Authorize
- type GetOEmbed
- type GetPoll
- type GetPreferences
- type GetScheduledStatus
- type GetScheduledStatuses
- type GetSearch
- type GetStatus
- type GetStatus_Context
- type GetStatus_FavouritedBy
- type GetStatus_History
- type GetStatus_RebloggedBy
- type GetStatus_Source
- type GetSuggestions
- type GetTag
- type GetTimeline_Hashtag
- type GetTimeline_Home
- type GetTimeline_List
- type GetTimeline_Public
- type GetTrends
- type GetTrends_Links
- type GetTrends_Statuses
- type PatchAccount_UpdateCredentials
- type PostAccount
- type PostAccount_Block
- type PostAccount_Follow
- type PostAccount_Mute
- type PostAccount_Note
- type PostAccount_Pin
- type PostAccount_RemoveFromFollowers
- type PostAccount_Unblock
- type PostAccount_Unfollow
- type PostAccount_Unmute
- type PostAccount_Unpin
- type PostAnnouncement_Dismiss
- type PostApplication
- type PostConversationRead
- type PostDomainBlock
- type PostEmailConfirmation
- type PostFeaturedTag
- type PostFilter
- type PostFilter_Keyword
- type PostFilter_Status
- type PostFilter_V1
- type PostFollowRequest_Authorize
- type PostFollowRequest_Reject
- type PostList
- type PostList_Accounts
- type PostMarker
- type PostMedia
- type PostNotification_Dismiss
- type PostNotifications_Clear
- type PostOAuth_Revoke
- type PostOAuth_Token
- type PostPoll_Votes
- type PostReport
- type PostStatus
- type PostStatus_Bookmark
- type PostStatus_Favourite
- type PostStatus_Mute
- type PostStatus_Pin
- type PostStatus_Reblog
- type PostStatus_Translate
- type PostStatus_Unbookmark
- type PostStatus_Unfavourite
- type PostStatus_Unmute
- type PostStatus_Unpin
- type PostStatus_Unreblog
- type PostTag_Follow
- type PostTag_Unfollow
- type PutAnnouncement_Reaction
- type PutFilter
- type PutFilter_Keyword
- type PutFilter_V1
- type PutList
- type PutScheduledStatus
- type PutStatus
- type QueryPage
- type QueryPager
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type DeleteAnnouncement_Reaction ¶
type DeleteAnnouncement_Reaction struct { Host string `header:"Host"` ID string `param:"id"` Name string `param:"name"` }
https://docs.joinmastodon.org/methods/announcements/#delete-reactions DELETE /api/v1/announcements/:id/reactions/:name Returns: Empty struct
type DeleteConversation ¶
https://docs.joinmastodon.org/methods/conversations/#delete DELETE /api/v1/conversations/:id Returns: Empty struct
type DeleteDomainBlock ¶
https://docs.joinmastodon.org/methods/domain_blocks/#unblock DELETE /api/v1/domain_blocks Returns: Empty struct
type DeleteFeaturedTag ¶
https://docs.joinmastodon.org/methods/featured_tags/#unfeature DELETE /api/v1/featured_tags/:id Returns: Empty object
type DeleteFilter ¶
type DeleteFilter struct { Host string `header:"Host"` ID string `param:"id"` // The ID of the Filter in the database. }
https://docs.joinmastodon.org/methods/filters/#delete DELETE /api/v2/filters/:id Returns: Empty object Delete a filter group.
type DeleteFilter_Keyword ¶
type DeleteFilter_Keyword struct { Host string `header:"Host"` ID string `param:"id"` // The ID of the FilterKeyword in the database. }
https://docs.joinmastodon.org/methods/filters/#keywords-delete DELETE /api/v2/filters/keywords/:id Returns: Empty object Delete the given filter keyword.
type DeleteFilter_Status ¶
type DeleteFilter_Status struct { Host string `header:"Host"` ID string `param:"id"` // The ID of the FilterStatus in the database. }
https://docs.joinmastodon.org/methods/filters/#statuses-remove DELETE /api/v2/filters/statuses/:id Returns: FilterStatus Remove a status filter from the current filter group.
type DeleteFilter_V1 ¶
https://docs.joinmastodon.org/methods/filters/#delete-v1 DELETE /api/v1/filters/:id Returns Empty object
type DeleteList ¶
https://docs.joinmastodon.org/methods/lists/#delete DELETE /api/v1/lists/:id
type DeleteList_Accounts ¶
type DeleteList_Accounts struct { Host string `header:"Host"` ID string `param:"id"` AccountIDs []string `form:"account_ids"` }
https://docs.joinmastodon.org/methods/lists/#accounts-remove DELETE /api/v1/lists/:id/accounts Returns: Empty Struct Remove accounts from the given list.
type DeleteProfile_Avatar ¶
type DeleteProfile_Avatar struct {
Host string `header:"Host"`
}
https://docs.joinmastodon.org/methods/profile/#delete-profile-avatar DELETE /api/v1/profile/avatar Returns: CredentialAccount
type DeleteProfile_Header ¶
type DeleteProfile_Header struct {
Host string `header:"Host"`
}
https://docs.joinmastodon.org/methods/profile/#delete-profile-header DELETE /api/v1/profile/header Returns: CredentialAccount
type DeleteScheduledStatus ¶
https://docs.joinmastodon.org/methods/scheduled_statuses/#cancel DELETE /api/v1/scheduled_statuses/:id Returns: Empty struct
type DeleteStatus ¶
https://docs.joinmastodon.org/methods/statuses/#delete DELETE /api/v1/statuses/:id
type DeleteSuggestion ¶
https://docs.joinmastodon.org/methods/suggestions/#remove DELETE /api/v1/suggestions/:account_id Returns Empty Struct
type GetAccount ¶
https://docs.joinmastodon.org/methods/accounts/#get GET /api/v1/accounts/:id
type GetAccount_FamiliarFollowers ¶
https://docs.joinmastodon.org/methods/accounts/#familiar_followers GET /api/v1/accounts/:id/familiar_followers Returns: Array of FamiliarFollower
type GetAccount_FeaturedTags ¶
https://docs.joinmastodon.org/methods/accounts/#featured_tags GET /api/v1/accounts/:id/featured_tags
type GetAccount_Followers ¶
type GetAccount_Followers struct { Host string `header:"Host"` ID string `param:"id"` MaxID string `query:"max_id"` SinceID string `query:"since_id"` MinID string `query:"min_id"` Limit int64 `query:"limit"` }
https://docs.joinmastodon.org/methods/accounts/#followers GET /api/v1/accounts/:id/followers
func (GetAccount_Followers) QueryPage ¶
func (t GetAccount_Followers) QueryPage() QueryPage
QueryPage implements the QueryPager interface, returning the QueryPage data embedded in this transaction
type GetAccount_Following ¶
type GetAccount_Following struct { Host string `header:"Host"` ID string `param:"id"` MaxID string `query:"max_id"` SinceID string `query:"since_id"` MinID string `query:"min_id"` Limit int64 `query:"limit"` }
https://docs.joinmastodon.org/methods/accounts/#following GET /api/v1/accounts/:id/following
func (GetAccount_Following) QueryPage ¶
func (t GetAccount_Following) QueryPage() QueryPage
QueryPage implements the QueryPager interface, returning the QueryPage data embedded in this transaction
type GetAccount_Lists ¶
https://docs.joinmastodon.org/methods/accounts/#lists GET /api/v1/accounts/:id/lists
type GetAccount_Lookup ¶
https://docs.joinmastodon.org/methods/accounts/#lookup GET /api/v1/accounts/lookup Returns: Account
type GetAccount_Relationships ¶
https://docs.joinmastodon.org/methods/accounts/#relationships GET /api/v1/accounts/relationships Returns: Array of Relationships
type GetAccount_Search ¶
type GetAccount_Search struct { Host string `header:"Host"` Q string `query:"q"` Limit int `query:"limit"` Offset int `query:"offset"` Resolve bool `query:"resolve"` Following bool `query:"following"` }
https://docs.joinmastodon.org/methods/accounts/#search GET /api/v1/accounts/search Returns: Array of Account
type GetAccount_Statuses ¶
type GetAccount_Statuses struct { Host string `header:"Host"` ID string `param:"id"` MaxID string `query:"max_id"` SinceID string `query:"since_id"` MinID string `query:"min_id"` Limit int64 `query:"limit"` OnlyMedia bool `query:"only_media"` ExcludeReplies bool `query:"exclude_replies"` ExcludeReblogs bool `query:"exclude_reblogs"` Pinned bool `query:"pinned"` Tagged string `query:"tagged"` }
https://docs.joinmastodon.org/methods/accounts/#statuses GET /api/v1/accounts/:id/statuses
func (GetAccount_Statuses) QueryPage ¶
func (t GetAccount_Statuses) QueryPage() QueryPage
QueryPage implements the QueryPager interface, returning the QueryPage data embedded in this transaction
type GetAccount_VerifyCredentials ¶
type GetAccount_VerifyCredentials struct {
Host string `header:"Host"`
}
https://docs.joinmastodon.org/methods/accounts/#verify_credentials GET /api/v1/accounts/verify_credentials Returns: CredentialAccount Test to make sure that the user token works.
type GetAnnouncements ¶
type GetAnnouncements struct { Host string `header:"Host"` Authorization string `header:"Authorization"` WithDismissed bool `query:"with_dismissed"` }
https://docs.joinmastodon.org/methods/announcements/#get GET /api/v1/announcements Returns: Array of Announcement
type GetApplication_VerifyCredentials ¶
type GetApplication_VerifyCredentials struct {
Host string `header:"Host"`
}
https://docs.joinmastodon.org/methods/apps/#verify_credentials GET /api/v1/apps/verify_credentials Returns: Application
type GetBlocks ¶
type GetBlocks struct { Host string `header:"Host"` MaxID string `query:"max_id"` SinceID string `query:"since_id"` MinID string `query:"min_id"` Limit int64 `query:"limit"` }
https://docs.joinmastodon.org/methods/blocks/#get GET /api/v1/blocks Returns: Array of Account
type GetBookmarks ¶
type GetBookmarks struct { Host string `header:"Host"` MaxID string `query:"max_id"` SinceID string `query:"since_id"` MinID string `query:"min_id"` Limit int64 `query:"limit"` }
https://docs.joinmastodon.org/methods/bookmarks/#get GET /api/v1/bookmarks Returns: Array of Status Statuses the user has bookmarked.
func (GetBookmarks) QueryPage ¶
func (t GetBookmarks) QueryPage() QueryPage
QueryPage implements the QueryPager interface, returning the QueryPage data embedded in this transaction
type GetConversations ¶
type GetConversations struct { Host string `header:"Host"` MaxID string `query:"max_id"` SinceID string `query:"since_id"` MinID string `query:"min_id"` Limit int64 `query:"limit"` }
https://docs.joinmastodon.org/methods/conversations/#get GET /api/v1/conversations Returns: Array of Conversation
func (GetConversations) QueryPage ¶
func (t GetConversations) QueryPage() QueryPage
QueryPage implements the QueryPager interface, returning the QueryPage data embedded in this transaction
type GetCustomEmojis ¶
type GetCustomEmojis struct{}
https://docs.joinmastodon.org/methods/custom_emojis/#get GET /api/v1/custom_emojis Returns: Array of CustomEmoji Returns custom emojis that are available on the server.
type GetDirectory ¶
type GetDirectory struct { Host string `header:"Host"` Offset int `query:"offset"` Limit int `query:"limit"` Order string `query:"order"` Local bool `query:"local"` }
https://docs.joinmastodon.org/methods/directory/#get GET /api/v1/directory Returns: Array of Account List accounts visible in the directory.
type GetDomainBlocks ¶
type GetDomainBlocks struct { Host string `header:"Host"` Authorization string `header:"Authorization"` MaxID string `query:"max_id"` SinceID string `query:"since_id"` MinID string `query:"min_id"` Limit int64 `query:"limit"` }
https://docs.joinmastodon.org/methods/domain_blocks/#get GET /api/v1/domain_blocks Returns: Array of String
func (GetDomainBlocks) QueryPage ¶
func (t GetDomainBlocks) QueryPage() QueryPage
QueryPage implements the QueryPager interface, returning the QueryPage data embedded in this transaction
type GetEndorsements ¶
type GetEndorsements struct { Host string `header:"Host"` MaxID string `query:"max_id"` MinID string `query:"min_id"` SinceID string `query:"since_id"` Limit int64 `query:"limit"` }
https://docs.joinmastodon.org/methods/endorsements/#get GET /api/v1/endorsements Returns: Array of Account
func (GetEndorsements) QueryPage ¶
func (t GetEndorsements) QueryPage() QueryPage
QueryPage implements the QueryPager interface, returning the QueryPage data embedded in this transaction
type GetFavourites ¶
type GetFavourites struct { Host string `header:"Host"` MaxID string `query:"max_id"` SinceID string `query:"since_id"` MinID string `query:"min_id"` Limit int64 `query:"limit"` }
https://docs.joinmastodon.org/methods/favourites/#get GET /api/v1/favourites Returns: Array of Status
func (GetFavourites) QueryPage ¶
func (t GetFavourites) QueryPage() QueryPage
QueryPage implements the QueryPager interface, returning the QueryPage data embedded in this transaction
type GetFeaturedTags ¶
type GetFeaturedTags struct { Host string `header:"Host"` Authorization string `header:"Authorization"` }
https://docs.joinmastodon.org/methods/featured_tags/#get GET /api/v1/featured_tags Returns: Array of FeaturedTag
type GetFeaturedTags_Suggestions ¶
type GetFeaturedTags_Suggestions struct {
Host string `header:"Host"`
}
https://docs.joinmastodon.org/methods/featured_tags/#suggestions GET /api/v1/featured_tags/suggestions Returns: Array of FeaturedTag
type GetFilter ¶
https://docs.joinmastodon.org/methods/filters/#get-one GET /api/v2/filters/:id Returns: Filter
type GetFilter_Keyword ¶
type GetFilter_Keyword struct { Host string `header:"Host"` ID string `param:"id"` // The ID of the FilterKeyword in the database. }
https://docs.joinmastodon.org/methods/filters/#keywords-get-one GET /api/v2/filters/keywords/:id Returns: FilterKeyword Get one filter keyword by the given id
type GetFilter_Keywords ¶
type GetFilter_Keywords struct { Host string `header:"Host"` FilterID string `param:"filter_id"` // The ID of the Filter in the database. }
https://docs.joinmastodon.org/methods/filters/#keywords-get GET /api/v2/filters/:filter_id/keywords Returns: Array of FilterKeyword List all keywords attached to the current filter group.
type GetFilter_Status ¶
type GetFilter_Status struct { Host string `header:"Host"` ID string `param:"id"` // The ID of the FilterStatus in the database. }
https://docs.joinmastodon.org/methods/filters/#statuses-get-one GET /api/v2/filters/statuses/:id Returns: FilterStatus Obtain a single status filter.
type GetFilter_Statuses ¶
type GetFilter_Statuses struct { Host string `header:"Host"` FilterID string `param:"filter_id"` // The ID of the Filter in the database. }
https://docs.joinmastodon.org/methods/filters/#statuses-get GET /api/v2/filters/:filter_id/statuses Returns: Array of FilterStatus Obtain a list of all status filters within this filter group.
type GetFilter_V1 ¶
https://docs.joinmastodon.org/methods/filters/#get-one-v1 GET /api/v1/filters/:id Returns V1::"Filter"
type GetFilters ¶
type GetFilters struct {
Host string `header:"Host"`
}
https://docs.joinmastodon.org/methods/filters/#get GET /api/v2/filters Returns: Array of Filter
type GetFilters_V1 ¶
type GetFilters_V1 struct {
Host string `header:"Host"`
}
https://docs.joinmastodon.org/methods/filters/#get-v1 GET /api/v1/filters Returns List of V1::"Filter"
type GetFollowRequests ¶
type GetFollowRequests struct { Host string `header:"Host"` MaxID string `query:"max_id"` MinID string `query:"min_id"` SinceID string `query:"since_id"` Limit int64 `query:"limit"` }
https://docs.joinmastodon.org/methods/follow_requests/#get GET /api/v1/follow_requests Returns: Array of Account
func (GetFollowRequests) QueryPage ¶
func (t GetFollowRequests) QueryPage() QueryPage
QueryPage implements the QueryPager interface, returning the QueryPage data embedded in this transaction
type GetFollowedTags ¶
type GetFollowedTags struct { Host string `header:"Host"` MaxID string `query:"max_id"` SinceID string `query:"since_id"` MinID string `query:"min_id"` Limit int64 `query:"limit"` }
https://docs.joinmastodon.org/methods/followed_tags/#get GET /api/v1/followed_tags Returns: Array of Tag
func (GetFollowedTags) QueryPage ¶
func (t GetFollowedTags) QueryPage() QueryPage
QueryPage implements the QueryPager interface, returning the QueryPage data embedded in this transaction
type GetInstance ¶
type GetInstance struct {
Host string `header:"Host"`
}
https://docs.joinmastodon.org/methods/instance/#v2 GET /api/v2/instance Returns: Instance
type GetInstance_Activity ¶
type GetInstance_Activity struct {
Host string `header:"Host"`
}
https://docs.joinmastodon.org/methods/instance/#activity GET /api/v1/instance/activity Returns: []map[string]any Instance activity over the last 3 months, binned weekly.
type GetInstance_DomainBlocks ¶
type GetInstance_DomainBlocks struct {
Host string `header:"Host"`
}
https://docs.joinmastodon.org/methods/instance/#domain_blocks GET /api/v1/instance/domain_blocks Returns: []DomainBlock Obtain a list of domains that have been blocked.
type GetInstance_ExtendedDescription ¶
type GetInstance_ExtendedDescription struct {
Host string `header:"Host"`
}
https://docs.joinmastodon.org/methods/instance/#extended_description GET /api/v1/instance/extended_description Returns: ExtendedDescription Obtain an extended description of this server
type GetInstance_Peers ¶
type GetInstance_Peers struct {
Host string `header:"Host"`
}
https://docs.joinmastodon.org/methods/instance/#peers GET /api/v1/instance/peers Returns: []string Domains that this instance is aware of.
type GetInstance_Rules ¶
type GetInstance_Rules struct {
Host string `header:"Host"`
}
https://docs.joinmastodon.org/methods/instance/#rules GET /api/v1/instance/rules Returns: []Rule Rules that the users of this service should follow.
type GetInstance_V1 ¶ added in v0.2.0
type GetInstance_V1 struct {
Host string `header:"Host"`
}
https://docs.joinmastodon.org/methods/instance/#v1 GET /api/v1/instance Returns: Instance_V1 Obtain general information about the server.
type GetList ¶
https://docs.joinmastodon.org/methods/lists/#get-one GET /api/v1/lists/:id Returns: List
type GetList_Accounts ¶
type GetList_Accounts struct { Host string `header:"Host"` ID string `param:"id"` MaxID string `query:"max_id"` SinceID string `query:"since_id"` MinID string `query:"min_id"` Limit int64 `query:"limit"` }
https://docs.joinmastodon.org/methods/lists/#accounts GET /api/v1/lists/:id/accounts Returns: Array of Account
func (GetList_Accounts) QueryPage ¶
func (t GetList_Accounts) QueryPage() QueryPage
QueryPage implements the QueryPager interface, returning the QueryPage data embedded in this transaction
type GetLists ¶
type GetLists struct {
Host string `header:"Host"`
}
https://docs.joinmastodon.org/methods/lists/#get GET /api/v1/lists Returns: Array of List
type GetMarkers ¶
https://docs.joinmastodon.org/methods/markers/#get GET /api/v1/markers Returns: Marker
type GetMutes ¶
type GetMutes struct { Host string `header:"Host"` MaxID string `query:"max_id"` MinID string `query:"min_id"` SinceID string `query:"since_id"` Limit int64 `query:"limit"` }
https://docs.joinmastodon.org/methods/mutes/#get GET /api/v1/mutes Returns: Array of Account
type GetNotification ¶
https://docs.joinmastodon.org/methods/notifications/#get-one GET /api/v1/notifications/:id Returns: Notification
type GetNotifications ¶
type GetNotifications struct { Host string `header:"Host"` MaxID string `query:"max_id"` SinceID string `query:"since_id"` MinID string `query:"min_id"` Limit int64 `query:"limit"` Types []string `query:"types"` ExcludeTypes []string `query:"exclude_types"` AccountID string `query:"account_id"` }
https://docs.joinmastodon.org/methods/notifications/#get GET /api/v1/notifications Returns: []Notification
func (GetNotifications) QueryPage ¶
func (t GetNotifications) QueryPage() QueryPage
QueryPage implements the QueryPager interface, returning the QueryPage data embedded in this transaction
type GetOAuth_Authorize ¶
type GetOAuth_Authorize struct { Host string `header:"Host"` ResponseType string `query:"response_type"` ClientID string `query:"client_id"` RedirectURI string `query:"redirect_uri"` Scope string `query:"scope"` ForceLogin bool `query:"force_login"` Language string `query:"language"` }
https://docs.joinmastodon.org/methods/oauth/#authorize GET /oauth/authorize Returns: Authorization code
type GetOEmbed ¶
type GetOEmbed struct { Host string `header:"Host"` URL string `query:"url"` MaxWidth int `query:"maxwidth"` MaxHeight int `query:"maxheight"` }
https://docs.joinmastodon.org/methods/oembed/#get GET /api/oembed Returns: OEmbed metadata
type GetPoll ¶
https://docs.joinmastodon.org/methods/polls/#get GET /api/v1/polls/:id Returns: Poll View a Poll
type GetPreferences ¶
type GetPreferences struct {
Host string `header:"Host"`
}
https://docs.joinmastodon.org/methods/preferences/#get GET /api/v1/preferences Returns: Preferences
type GetScheduledStatus ¶
https://docs.joinmastodon.org/methods/scheduled_statuses/#get-one GET /api/v1/scheduled_statuses/:id Returns: ScheduledStatus
type GetScheduledStatuses ¶
type GetScheduledStatuses struct { Host string `header:"Host"` MaxID string `query:"max_id"` SinceID string `query:"since_id"` MinID string `query:"min_id"` Limit int64 `query:"limit"` }
https://docs.joinmastodon.org/methods/scheduled_statuses/#get GET /api/v1/scheduled_statuses Returns: []ScheduledStatus
func (GetScheduledStatuses) QueryPage ¶
func (t GetScheduledStatuses) QueryPage() QueryPage
QueryPage implements the QueryPager interface, returning the QueryPage data embedded in this transaction
type GetSearch ¶
type GetSearch struct { Host string `header:"Host"` Q string `query:"q"` Type string `query:"type"` // [accounts | hashtags | statuses] Resolve bool `query:"resolve"` Following bool `query:"following"` AccountID string `query:"account_id"` ExcludeUnreviewed bool `query:"exclude_unreviewed"` MaxID string `query:"max_id"` MinID string `query:"min_id"` SinceID string `query:"since_id"` Limit int64 `query:"limit"` Offset int `query:"offset"` }
https://docs.joinmastodon.org/methods/search/#v2 GET /api/v2/search Returns: Search
type GetStatus ¶
https://docs.joinmastodon.org/methods/statuses/#get GET /api/v1/statuses/:id Returns: Status
type GetStatus_Context ¶
https://docs.joinmastodon.org/methods/statuses/#context GET /api/v1/statuses/:id/context Returns: Context
type GetStatus_FavouritedBy ¶
type GetStatus_FavouritedBy struct { Host string `header:"Host"` ID string `param:"id"` MaxID string `query:"max_id"` MinID string `query:"min_id"` SinceID string `query:"since_id"` Limit int64 `query:"limit"` }
https://docs.joinmastodon.org/methods/statuses/#favourited_by GET /api/v1/statuses/:id/favourited_by Returns: []Account
func (GetStatus_FavouritedBy) QueryPage ¶
func (t GetStatus_FavouritedBy) QueryPage() QueryPage
QueryPage implements the QueryPager interface, returning the QueryPage data embedded in this transaction
type GetStatus_History ¶
https://docs.joinmastodon.org/methods/statuses/#history GET /api/v1/statuses/:id/history Returns: []StatusEdit
type GetStatus_RebloggedBy ¶
type GetStatus_RebloggedBy struct { Host string `header:"Host"` ID string `param:"id"` MaxID string `query:"max_id"` MinID string `query:"min_id"` SinceID string `query:"since_id"` Limit int64 `query:"limit"` }
https://docs.joinmastodon.org/methods/statuses/#reblogged_by GET /api/v1/statuses/:id/reblogged_by Returns: []Account
func (GetStatus_RebloggedBy) QueryPage ¶
func (t GetStatus_RebloggedBy) QueryPage() QueryPage
QueryPage implements the QueryPager interface, returning the QueryPage data embedded in this transaction
type GetStatus_Source ¶
https://docs.joinmastodon.org/methods/statuses/#source GET /api/v1/statuses/:id/source Returns: StatusSource
type GetSuggestions ¶
https://docs.joinmastodon.org/methods/suggestions/#v2 GET /api/v2/suggestions Returns: []Suggestion
type GetTag ¶
https://docs.joinmastodon.org/methods/tags/#get GET /api/v1/tags/:id Returns: Tag
type GetTimeline_Hashtag ¶
type GetTimeline_Hashtag struct { Host string `header:"Host"` Hashtag string `param:"hashtag"` Any []string `query:"any"` All []string `query:"all"` None []string `query:"none"` Local bool `query:"local"` Remote bool `query:"remote"` OnlyMedia bool `query:"only_media"` MaxID string `query:"max_id"` SinceID string `query:"since_id"` MinID string `query:"min_id"` Limit int64 `query:"limit"` }
https://docs.joinmastodon.org/methods/timelines/#tag GET /api/v1/timelines/tag/:hashtag Returns: []Status
func (GetTimeline_Hashtag) QueryPage ¶
func (t GetTimeline_Hashtag) QueryPage() QueryPage
QueryPage implements the QueryPager interface, returning the QueryPage data embedded in this transaction
type GetTimeline_Home ¶
type GetTimeline_Home struct { Host string `header:"Host"` MaxID string `query:"max_id"` SinceID string `query:"since_id"` MinID string `query:"min_id"` Limit int64 `query:"limit"` }
https://docs.joinmastodon.org/methods/timelines/#home GET /api/v1/timelines/home Returns: []Status
func (GetTimeline_Home) QueryPage ¶
func (t GetTimeline_Home) QueryPage() QueryPage
QueryPage implements the QueryPager interface, returning the QueryPage data embedded in this transaction
type GetTimeline_List ¶
type GetTimeline_List struct { Host string `header:"Host"` ListID string `param:"list_id"` MaxID string `query:"max_id"` SinceID string `query:"since_id"` MinID string `query:"min_id"` Limit int64 `query:"limit"` }
https://docs.joinmastodon.org/methods/timelines/#list GET /api/v1/timelines/list/:list_id Returns: []Status
func (GetTimeline_List) QueryPage ¶
func (t GetTimeline_List) QueryPage() QueryPage
QueryPage implements the QueryPager interface, returning the QueryPage data embedded in this transaction
type GetTimeline_Public ¶
type GetTimeline_Public struct { Host string `header:"Host"` Local bool `query:"local"` Remote bool `query:"remote"` OnlyMedia bool `query:"only_media"` MaxID string `query:"max_id"` SinceID string `query:"since_id"` MinID string `query:"min_id"` Limit int64 `query:"limit"` }
https://docs.joinmastodon.org/methods/timelines/#public GET /api/v1/timelines/public Returns: []Status
type GetTrends ¶
type GetTrends struct { Host string `header:"Host"` Limit int `query:"limit"` // Maximum number of results to return. Defaults to 10 tags. Max 20 tags. Offset int `query:"offset"` // Skip the first n results. }
https://docs.joinmastodon.org/methods/trends/#tags GET /api/v1/trends Returns: []Tag
type GetTrends_Links ¶
type GetTrends_Links struct { Host string `header:"Host"` Limit int `query:"limit"` // Maximum number of results to return. Defaults to 10 tags. Max 20 tags. Offset int `query:"offset"` // Skip the first n results. }
https://docs.joinmastodon.org/methods/trends/#links GET /api/v1/trends/links Returns: []Link
type GetTrends_Statuses ¶
type GetTrends_Statuses struct { Host string `header:"Host"` Limit int `query:"limit"` // Maximum number of results to return. Defaults to 10 tags. Max 20 tags. Offset int `query:"offset"` // Skip the first n results. }
https://docs.joinmastodon.org/methods/trends/#statuses GET /api/v1/trends/statuses Returns: []Status
type PatchAccount_UpdateCredentials ¶
type PatchAccount_UpdateCredentials struct { Host string `header:"Host"` DisplayName string `form:"display_name"` Note string `form:"note"` Avatar string `form:"avatar"` Header string `form:"header"` Locked bool `form:"locked"` Bot bool `form:"bot"` Discoverable bool `form:"discoverable"` }
https://docs.joinmastodon.org/methods/accounts/#update_credentials PATCH /api/v1/accounts/update_credentials
type PostAccount ¶
type PostAccount struct { Host string `header:"Host"` Username string `form:"username"` Email string `form:"email"` Password string `form:"password"` Agreement bool `form:"agreement"` Locale string `form:"locale"` Reason string `form:"reason"` }
https://docs.joinmastodon.org/methods/accounts/#create POST /api/v1/accounts Returns: Token Register an account
type PostAccount_Block ¶
https://docs.joinmastodon.org/methods/accounts/#block POST /api/v1/accounts/:id/block Returns: Relationship
type PostAccount_Follow ¶
type PostAccount_Follow struct { Host string `header:"Host"` ID string `param:"id"` Reblogs bool `form:"reblogs"` Notify bool `form:"notify"` Languages []string `form:"languages"` }
https://docs.joinmastodon.org/methods/accounts/#follow POST /api/v1/accounts/:id/follow
type PostAccount_Mute ¶
type PostAccount_Mute struct { Host string `header:"Host"` ID string `param:"id"` Notifications bool `form:"notifications"` Duration bool `form:"duration"` }
https://docs.joinmastodon.org/methods/accounts/#mute POST /api/v1/accounts/:id/mute Returns: Relationship
type PostAccount_Note ¶
type PostAccount_Note struct { Host string `header:"Host"` ID string `param:"id"` Comment string `form:"comment"` }
https://docs.joinmastodon.org/methods/accounts/#note POST /api/v1/accounts/:id/note Returns: Relationship
type PostAccount_Pin ¶
https://docs.joinmastodon.org/methods/accounts/#pin POST /api/v1/accounts/:id/pin Returns: Relationship
type PostAccount_RemoveFromFollowers ¶
https://docs.joinmastodon.org/methods/accounts/#remove_from_followers POST /api/v1/accounts/:id/remove_from_followers Returns: Relationship
type PostAccount_Unblock ¶
https://docs.joinmastodon.org/methods/accounts/#unblock POST /api/v1/accounts/:id/unblock Returns: Relationship
type PostAccount_Unfollow ¶
https://docs.joinmastodon.org/methods/accounts/#unfollow POST /api/v1/accounts/:id/unfollow
type PostAccount_Unmute ¶
https://docs.joinmastodon.org/methods/accounts/#unmute POST /api/v1/accounts/:id/unmute Returns: Relationship
type PostAccount_Unpin ¶
https://docs.joinmastodon.org/methods/accounts/#unpin POST /api/v1/accounts/:id/unpin Returns: Relationship
type PostAnnouncement_Dismiss ¶
type PostAnnouncement_Dismiss struct { Host string `header:"Host"` Authorization string `header:"Authorization"` ID string `param:"id"` }
https://docs.joinmastodon.org/methods/announcements/#dismiss POST /api/v1/announcements/:id/dismiss Returns: Empty struct
type PostApplication ¶
type PostApplication struct { Host string `header:"Host"` ClientName string `form:"client_name" json:"client_name"` RedirectURIs string `form:"redirect_uris" json:"redirect_uris"` Scopes string `form:"scopes" json:"scopes"` Website string `form:"website" json:"website"` }
https://docs.joinmastodon.org/methods/apps/#create POST /api/v1/apps Returns: Application
type PostConversationRead ¶
https://docs.joinmastodon.org/methods/conversations/#read POST /api/v1/conversations/:id/read Returns: Conversation
type PostDomainBlock ¶
https://docs.joinmastodon.org/methods/domain_blocks/#block POST /api/v1/domain_blocks Returns: Empty struct
type PostEmailConfirmation ¶
type PostEmailConfirmation struct {
Host string `header:"Host"`
}
https://docs.joinmastodon.org/methods/emails/#confirmation POST /api/v1/email/confirmation Returns: Empty object
type PostFeaturedTag ¶
https://docs.joinmastodon.org/methods/featured_tags/#feature POST /api/v1/featured_tags Returns: FeaturedTag
type PostFilter ¶
type PostFilter struct { Host string `header:"Host"` Title string `form:"title"` Context []string `form:"context"` FilterAction string `form:"filter_action"` ExpiresIn int `form:"expires_in"` KeywordsAttributes []struct { Host string `header:"Host"` Keyword string `form:"keyword"` WholeWord bool `form:"whole_word"` } `form:"keywords_attributes"` }
https://docs.joinmastodon.org/methods/filters/#create POST /api/v2/filters Returns: Filter Create a filter group with the given parameters.
type PostFilter_Keyword ¶
type PostFilter_Keyword struct { Host string `header:"Host"` FilterID string `param:"filter_id"` // The ID of the Filter in the database. Keyword string `form:"keyword"` // The keyword to be added to the filter group. WholeWord bool `form:"whole_word"` // Whether the keyword should consider word boundaries. }
https://docs.joinmastodon.org/methods/filters/#keywords-create POST /api/v2/filters/:filter_id/keywords Returns: FilterKeyword Add the given keyword to the specified filter group
type PostFilter_Status ¶
type PostFilter_Status struct { Host string `header:"Host"` FilterID string `param:"filter_id"` // The ID of the Filter in the database. }
https://docs.joinmastodon.org/methods/filters/#statuses-add POST /api/v2/filters/:filter_id/statuses Returns: FilterStatus Add a status filter to the current filter group.
type PostFilter_V1 ¶
type PostFilter_V1 struct { Host string `header:"Host"` Phrase string `form:"phrase"` Context []string `form:"context"` Irreversible bool `form:"irreversible"` WholeWord bool `form:"whole_word"` ExpiresIn int `form:"expires_in"` }
https://docs.joinmastodon.org/methods/filters/#create-v1 POST /api/v1/filters Returns V1::"Filter"
type PostFollowRequest_Authorize ¶
type PostFollowRequest_Authorize struct { Host string `header:"Host"` AccountID string `param:"account_id"` }
https://docs.joinmastodon.org/methods/follow_requests/#accept POST /api/v1/follow_requests/:account_id/authorize Returns: Relationship
type PostFollowRequest_Reject ¶
type PostFollowRequest_Reject struct { Host string `header:"Host"` AccountID string `param:"account_id"` }
https://docs.joinmastodon.org/methods/follow_requests/#reject POST /api/v1/follow_requests/:account_id/reject Returns: Relationship
type PostList ¶
type PostList struct { Host string `header:"Host"` Title string `form:"title"` RepliesPolicy string `form:"replies_policy"` Exclusive bool `form:"exclusive"` }
https://docs.joinmastodon.org/methods/lists/#create POST /api/v1/lists Returns: List
type PostList_Accounts ¶
type PostList_Accounts struct { Host string `header:"Host"` ID string `param:"id"` AccountIDs []string `form:"account_ids"` }
https://docs.joinmastodon.org/methods/lists/#accounts-add POST /api/v1/lists/:id/accounts Returns: Empty Struct Add accounts to the given list. Note that the user must be following these accounts.
type PostMarker ¶
type PostMarker struct { Host string `header:"Host"` Home struct { Host string `header:"Host"` LastReadID string `form:"last_read_id"` } `form:"home"` Notifications struct { Host string `header:"Host"` LastReadID string `form:"last_read_id"` } `form:"notifications"` }
https://docs.joinmastodon.org/methods/markers/#create POST /api/v1/markers Returns: Marker
type PostMedia ¶
type PostMedia struct { Host string `header:"Host"` File string `form:"file"` Thumbnail string `form:"thumbnail"` Description string `form:"description"` Focus string `form:"focus"` }
https://docs.joinmastodon.org/methods/media/#v2 POST /api/v2/media Returns: MediaAttachment
type PostNotification_Dismiss ¶
https://docs.joinmastodon.org/methods/notifications/#dismiss POST /api/v1/notifications/dismiss Returns: Empty Struct
type PostNotifications_Clear ¶
type PostNotifications_Clear struct {
Host string `header:"Host"`
}
https://docs.joinmastodon.org/methods/notifications/#clear POST /api/v1/notifications/clear Returns: Empty Struct
type PostOAuth_Revoke ¶
type PostOAuth_Revoke struct { Host string `header:"Host"` ClientID string `form:"client_id"` ClientSecret string `form:"client_secret"` Token string `form:"token"` }
https://docs.joinmastodon.org/methods/oauth/#revoke POST /oauth/revoke Returns: Empty struct Revoke an access token to make it no longer valid for use
type PostOAuth_Token ¶
type PostOAuth_Token struct { Host string `header:"Host"` GrantType string `form:"grant_type"` Code string `form:"code"` ClientID string `form:"client_id"` ClientSecret string `form:"client_secret"` RedirectURI string `form:"redirect_uri"` Scope string `form:"scope"` }
https://docs.joinmastodon.org/methods/oauth/#token POST /oauth/token Returns: Token Obtain an access token, to be used during API calls that are not public
type PostPoll_Votes ¶
type PostPoll_Votes struct { Host string `header:"Host"` ID string `param:"id"` Choices []int `json:"choices"` }
https://docs.joinmastodon.org/methods/polls/#vote POST /api/v1/polls/:id/votes Returns: Poll Vote on a Poll
type PostReport ¶
type PostReport struct { Host string `header:"Host"` AccountID string `form:"account_id"` StatusIDs []string `form:"status_ids"` Comment string `form:"comment"` Forward bool `form:"forward"` Category string `form:"category"` RuleIDs []string `form:"rule_ids"` }
https://docs.joinmastodon.org/methods/reports/#post POST /api/v1/reports Returns: Report
type PostStatus ¶
type PostStatus struct { Host string `header:"Host"` Status string `form:"status"` MediaIDs []string `form:"media_ids"` Poll struct { Host string `header:"Host"` Options []string `form:"options"` ExpiresIn int `form:"expires_in"` Multiple bool `form:"multiple"` HideTotals bool `form:"hide_totals"` } `form:"poll"` InReplyToID string `form:"in_reply_to_id"` Sensitive bool `form:"sensitive"` SpoilerText string `form:"spoiler_text"` Visibility string `form:"visibility"` // [public | unlisted | private | direct] Language string `form:"language"` // ISO 629 2-letter language code ScheduledAt string `form:"scheduled_at"` // ISO 8601 Datetime }
https://docs.joinmastodon.org/methods/statuses/#create POST /api/v1/statuses Returns: Status
type PostStatus_Bookmark ¶
https://docs.joinmastodon.org/methods/statuses/#bookmark POST /api/v1/statuses/:id/bookmark Returns: Status
type PostStatus_Favourite ¶
https://docs.joinmastodon.org/methods/statuses/#favourite POST /api/v1/statuses/:id/favourite Returns: Status
type PostStatus_Mute ¶
https://docs.joinmastodon.org/methods/statuses/#mute POST /api/v1/statuses/:id/mute Returns: Status
type PostStatus_Pin ¶
https://docs.joinmastodon.org/methods/statuses/#pin POST /api/v1/statuses/:id/pin Returns: Status
type PostStatus_Reblog ¶
type PostStatus_Reblog struct { Host string `header:"Host"` ID string `param:"id"` Visibility string `form:"visibility"` // [public | unlisted | private] }
https://docs.joinmastodon.org/methods/statuses/#reblog POST /api/v1/statuses/:id/reblog Returns: Status
type PostStatus_Translate ¶
type PostStatus_Translate struct { Host string `header:"Host"` ID string `param:"id"` Lang string `form:"lang"` }
https://docs.joinmastodon.org/methods/statuses/#translate POST /api/v1/statuses/:id/translate Returns: Status
type PostStatus_Unbookmark ¶
https://docs.joinmastodon.org/methods/statuses/#unbookmark POST /api/v1/statuses/:id/unbookmark Returns: Status
type PostStatus_Unfavourite ¶
https://docs.joinmastodon.org/methods/statuses/#unfavourite POST /api/v1/statuses/:id/unfavourite Returns: Status
type PostStatus_Unmute ¶
https://docs.joinmastodon.org/methods/statuses/#unmute POST /api/v1/statuses/:id/unmute Returns: Status
type PostStatus_Unpin ¶
https://docs.joinmastodon.org/methods/statuses/#unpin POST /api/v1/statuses/:id/unpin Returns: Status
type PostStatus_Unreblog ¶
https://docs.joinmastodon.org/methods/statuses/#unreblog POST /api/v1/statuses/:id/unreblog Returns: Status
type PostTag_Follow ¶
https://docs.joinmastodon.org/methods/tags/#follow POST /api/v1/tags/:id/follow Returns: Tag
type PostTag_Unfollow ¶
https://docs.joinmastodon.org/methods/tags/#unfollow POST /api/v1/tags/:id/unfollow Returns: Tag
type PutAnnouncement_Reaction ¶
type PutAnnouncement_Reaction struct { Host string `header:"Host"` ID string `param:"id"` Name string `param:"name"` }
https://docs.joinmastodon.org/methods/announcements/#put-reactions PUT /api/v1/announcements/:id/reactions/:name Returns: Empty struct
type PutFilter ¶
type PutFilter struct { Host string `header:"Host"` ID string `param:"id"` // The ID of the Filter in the database. Title string `form:"title"` // The name of the filter group. Context []string `form:"context"` // Where the filter should be applied. Specify at least one of home, notifications, public, thread, account. FilterAction string `form:"filter_action"` // The policy to be applied when the filter is matched. Specify warn or hide. ExpiresIn int `form:"expires_in"` // How many seconds from now should the filter expire? KeywordsAttributes []struct { Host string `header:"Host"` Keyword string `form:"keyword"` // A keyword to be added to the newly-created filter group. WholeWord bool `form:"whole_word"` // Whether the keyword should consider word boundaries. ID string `form:"id"` // Provide the ID of an existing keyword to modify it, instead of creating a new keyword. Destroy bool `form:"_destroy"` // If true, will remove the keyword with the given ID. } `form:"keywords_attributes"` }
https://docs.joinmastodon.org/methods/filters/#update PUT /api/v2/filters/:id Returns: Filter Update a filter group with the given parameters.
type PutFilter_Keyword ¶
type PutFilter_Keyword struct { Host string `header:"Host"` ID string `param:"id"` // The ID of the FilterKeyword in the database. Keyword string `form:"keyword"` // The keyword to be added to the filter group. WholeWord bool `form:"whole_word"` // Whether the keyword should consider word boundaries. }
https://docs.joinmastodon.org/methods/filters/#keywords-update PUT /api/v2/filters/keywords/:id Returns: FilterKeyword Update the given filter keyword.
type PutFilter_V1 ¶
type PutFilter_V1 struct { Host string `header:"Host"` ID string `param:"id"` Phrase string `form:"phrase"` Context []string `form:"context"` Irreversible bool `form:"irreversible"` WholeWord bool `form:"whole_word"` ExpiresIn int `form:"expires_in"` }
https://docs.joinmastodon.org/methods/filters/#update-v1 PUT /api/v1/filters/:id Returns V1::"Filter"
type PutList ¶
type PutList struct { Host string `header:"Host"` ID string `param:"id"` Title string `form:"title"` RepliesPolicy string `form:"replies_policy"` }
https://docs.joinmastodon.org/methods/lists/#update PUT /api/v1/lists/:id Returns: List
type PutScheduledStatus ¶
type PutScheduledStatus struct { Host string `header:"Host"` ID string `param:"id"` ScheduledAt string `form:"scheduled_at"` // ISO 8601 Datetime }
https://docs.joinmastodon.org/methods/scheduled_statuses/#update PUT /api/v1/scheduled_statuses/:id Returns: ScheduledStatus
type PutStatus ¶
type PutStatus struct { Host string `header:"Host"` ID string `param:"id"` Status string `form:"status"` SpoilerText string `form:"spoiler_text"` Sensitive bool `form:"sensitive"` Language string `form:"language"` MediaIDs []string `form:"media_ids[]"` Poll struct { Host string `header:"Host"` Options []string `form:"options[]"` ExpiresIn int `form:"expires_in"` Multiple bool `form:"multiple"` HideTotals bool `form:"hide_totals"` } `form:"poll"` }
https://docs.joinmastodon.org/methods/statuses/#edit PUT /api/v1/statuses/:id Returns: Status
type QueryPage ¶
type QueryPage struct { Limit int64 `query:"limit"` // The maximum number of results to return. Usually, there is a default limit and a maximum limit; these will vary according to the API method. MaxID string `query:"max_id"` // All results returned will be lesser than this ID. In effect, sets an upper bound on results. MinID string `query:"min_id"` // Returns results immediately newer than this ID. In effect, sets a cursor at this ID and paginates forward. SinceID string `query:"since_id"` // All results returned will be greater than this ID. In effect, sets a lower bound on results. }
QueryPage represents the query parameters that are common to many Mastodon API calls. Many API methods allow you to paginate for more information, using parameters such as limit, max_id, min_id, and since_id. https://docs.joinmastodon.org/api/guidelines/#pagination
type QueryPager ¶
type QueryPager interface { // QueryPage extracts the query page data from an object QueryPage() QueryPage }
QueryPager wraps the QueryPage method, and is implemented by all "query" transactions
Source Files
¶
- accounts.go
- admin-.go
- admin-accounts.go
- admin-canonical-email-blocks.go
- admin-dimensions.go
- admin-domain-allows.go
- admin-domain-blocks.go
- admin-email-blocks.go
- admin-ip-blocks.go
- admin-measures.go
- admin-reports.go
- admin-retention.go
- admin-trends.go
- announcements.go
- apps.go
- blocks.go
- bookmarks.go
- conversations.go
- custom-emojis.go
- directory.go
- domain-blocks.go
- emails.go
- endorsements.go
- favourites.go
- featured-tags.go
- filters.go
- follow-requests.go
- followed-tags.go
- instance.go
- lists.go
- markers.go
- media.go
- mutes.go
- notifications.go
- oauth.go
- oembed.go
- polls.go
- preferences.go
- profile.go
- push.go
- queryPage.go
- reports.go
- scheduled-statuses.go
- search.go
- statuses.go
- streaming.go
- suggestions.go
- tags.go
- timelines.go
- trends.go