Class Firefish

Implements

MegalodonInterface

Index

Constructors

Properties

Methods

acceptFollowRequest addAccountsToList addReactionToAnnouncement blockAccount blockDomain bookmarkStatus cancel cancelScheduledStatus createApp createEmojiReaction createFeaturedTag createFilter createList deleteAccountsFromList deleteConversation deleteEmojiReaction deleteFeaturedTag deleteFilter deleteList deletePushSubscription deleteStatus directStreaming dismissInstanceAnnouncement dismissNotification dismissNotifications editStatus favouriteStatus fetchAccessToken followAccount followTag generateAuthUrlAndToken getAccount getAccountFavourites getAccountFollowers getAccountFollowing getAccountLists getAccountsInList getAccountStatuses getBlocks getBookmarks getConversationTimeline getDomainBlocks getEmojiReaction getEmojiReactions getEndorsements getFavourites getFeaturedTags getFilter getFilters getFollowedTags getFollowRequests getHomeTimeline getIdentityProof getInstance getInstanceActivity getInstanceAnnouncements getInstanceCustomEmojis getInstanceDirectory getInstancePeers getInstanceTrends getList getLists getListTimeline getLocalTimeline getMarkers getMedia getMutes getNotification getNotifications getPoll getPreferences getPublicTimeline getPushSubscription getRelationship getRelationships getScheduledStatus getScheduledStatuses getStatus getStatusContext getStatusFavouritedBy getStatusRebloggedBy getStatusSource getSuggestedTags getSuggestions getTag getTagTimeline listStreaming localStreaming lookupAccount muteAccount muteStatus pinAccount pinStatus postStatus publicStreaming readConversation readNotifications reblogStatus refreshToken registerAccount registerApp rejectFollowRequest removeReactionFromAnnouncement report revokeToken saveMarkers scheduleStatus search searchAccount setAccountNote streamingURL subscribeAccount subscribePushNotification tagStreaming unblockAccount unblockDomain unbookmarkStatus unfavouriteStatus unfollowAccount unfollowTag unmuteAccount unmuteStatus unpinAccount unpinStatus unreblogStatus unsubscribeAccount updateCredentials updateFilter updateList updateMedia updatePushSubscription uploadMedia userStreaming verifyAccountCredentials verifyAppCredentials votePoll

Constructors

constructor

new Firefish(baseUrl, accessToken?, userAgent?): Firefish
Parameters
- baseUrl: string
  hostname or base URL
- accessToken: null | string = null
  access token from OAuth2 authorization
- userAgent: null | string = DEFAULT_UA
  UserAgent is specified in header on request.
Returns Firefish
- Defined in megalodon/src/firefish.ts:20

Properties

baseUrl

baseUrl: string

client

client: Interface

Methods

acceptFollowRequest

acceptFollowRequest(id): Promise<Response<Relationship>>
POST /api/following/requests/accept
Parameters
- id: string
Returns Promise<Response<Relationship>>
Implementation of MegalodonInterface.acceptFollowRequest
- Defined in megalodon/src/firefish.ts:879

addAccountsToList

addAccountsToList(id, account_ids): Promise<Response<Record<never, never>>>
POST /api/users/lists/push
Parameters
- id: string
- account_ids: string[]
Returns Promise<Response<Record<never, never>>>
Implementation of MegalodonInterface.addAccountsToList
- Defined in megalodon/src/firefish.ts:1831

addReactionToAnnouncement

addReactionToAnnouncement(_id, _name): Promise<Response<Record<never, never>>>
Add a reaction to an announcement.
Parameters
- _id: string
- _name: string
Returns Promise<Response<Record<never, never>>>
Implementation of MegalodonInterface.addReactionToAnnouncement
- Defined in megalodon/src/firefish.ts:2307

blockAccount

blockAccount(id): Promise<Response<Relationship>>
POST /api/blocking/create
Parameters
- id: string
Returns Promise<Response<Relationship>>
Implementation of MegalodonInterface.blockAccount
- Defined in megalodon/src/firefish.ts:472

blockDomain

blockDomain(_domain): Promise<Response<Record<never, never>>>
Block a domain.
Parameters
- _domain: string
Returns Promise<Response<Record<never, never>>>
Implementation of MegalodonInterface.blockDomain
- Defined in megalodon/src/firefish.ts:755

bookmarkStatus

bookmarkStatus(_id): Promise<Response<Status>>
Bookmark a status
Parameters
- _id: string
Returns Promise<Response<Status>>
Status.
Implementation of MegalodonInterface.bookmarkStatus
- Defined in megalodon/src/firefish.ts:1276

cancel

cancel(): void
Cancel all requests in this instance.

Returns void
void
Implementation of MegalodonInterface.cancel
- Defined in megalodon/src/firefish.ts:33

cancelScheduledStatus

cancelScheduledStatus(_id): Promise<Response<Record<never, never>>>
Cancel a scheduled status.
Parameters
- _id: string
Returns Promise<Response<Record<never, never>>>
Implementation of MegalodonInterface.cancelScheduledStatus
- Defined in megalodon/src/firefish.ts:1466

createApp

createApp(client_name, options?): Promise<AppData>
POST /api/app/create

Create an application.
Parameters
- client_name: string
  Your application's name.
- options: Partial<{
      redirect_uris: string;
      scopes: string[];
      website: string;
  }> = ...
  Form data.
Returns Promise<AppData>
Implementation of MegalodonInterface.createApp
- Defined in megalodon/src/firefish.ts:60

createEmojiReaction

createEmojiReaction(id, emoji): Promise<Response<Status>>
POST /api/notes/reactions/create
Parameters
- id: string
  Target note ID.
- emoji: string
  Reaction emoji string. This string is raw unicode emoji or custom emoji name (not shortcode).
Returns Promise<Response<Status>>
Implementation of MegalodonInterface.createEmojiReaction
- Defined in megalodon/src/firefish.ts:2330

createFeaturedTag

createFeaturedTag(_name): Promise<Response<FeaturedTag>>
Promote a hashtag on your profile.
Parameters
- _name: string
Returns Promise<Response<FeaturedTag>>
FeaturedTag.
Implementation of MegalodonInterface.createFeaturedTag
- Defined in megalodon/src/firefish.ts:936

createFilter

createFilter(_phrase, _context, _options?): Promise<Response<Filter>>
Create a filter.
Parameters
- _phrase: string
- _context: string[]
- Optional_options: {
      expires_in?: string;
      irreversible?: boolean;
      whole_word?: boolean;
  }
  - Optionalexpires_in?: string
  - Optionalirreversible?: boolean
  - Optionalwhole_word?: boolean
Returns Promise<Response<Filter>>
Filter
Implementation of MegalodonInterface.createFilter
- Defined in megalodon/src/firefish.ts:786

createList

createList(title): Promise<Response<List>>
POST /api/users/lists/create
Parameters
- title: string
Returns Promise<Response<List>>
Implementation of MegalodonInterface.createList
- Defined in megalodon/src/firefish.ts:1776

deleteAccountsFromList

deleteAccountsFromList(id, account_ids): Promise<Response<Record<never, never>>>
POST /api/users/lists/pull
Parameters
- id: string
- account_ids: string[]
Returns Promise<Response<Record<never, never>>>
Implementation of MegalodonInterface.deleteAccountsFromList
- Defined in megalodon/src/firefish.ts:1841

deleteConversation

deleteConversation(_id): Promise<Response<Record<never, never>>>
Remove a conversation.
Parameters
- _id: string
Returns Promise<Response<Record<never, never>>>
Implementation of MegalodonInterface.deleteConversation
- Defined in megalodon/src/firefish.ts:1736

deleteEmojiReaction

deleteEmojiReaction(id, emoji): Promise<Response<Status>>
POST /api/notes/reactions/delete
Parameters
- id: string
  Target note ID.
- emoji: string
  Reaction emoji string. This string is raw unicode emoji or custom emoji name (not shortcode).
Returns Promise<Response<Status>>
Implementation of MegalodonInterface.deleteEmojiReaction
- Defined in megalodon/src/firefish.ts:2348

deleteFeaturedTag

deleteFeaturedTag(_id): Promise<Response<Record<never, never>>>
Stop promoting a hashtag on your profile.
Parameters
- _id: string
Returns Promise<Response<Record<never, never>>>
Empty
Implementation of MegalodonInterface.deleteFeaturedTag
- Defined in megalodon/src/firefish.ts:943

deleteFilter

deleteFilter(_id): Promise<Response<Filter>>
Remove a filter.
Parameters
- _id: string
Returns Promise<Response<Filter>>
Removed filter.
Implementation of MegalodonInterface.deleteFilter
- Defined in megalodon/src/firefish.ts:817

deleteList

deleteList(id): Promise<Response<Record<never, never>>>
POST /api/users/lists/delete
Parameters
- id: string
Returns Promise<Response<Record<never, never>>>
Implementation of MegalodonInterface.deleteList
- Defined in megalodon/src/firefish.ts:1799

deletePushSubscription

deletePushSubscription(): Promise<Response<Record<never, never>>>
DELETE /api/v1/push/subscription

Returns Promise<Response<Record<never, never>>>
Implementation of MegalodonInterface.deletePushSubscription
- Defined in megalodon/src/firefish.ts:1982

deleteStatus

deleteStatus(id): Promise<Response<Record<never, never>>>
POST /api/notes/delete
Parameters
- id: string
Returns Promise<Response<Record<never, never>>>
Implementation of MegalodonInterface.deleteStatus
- Defined in megalodon/src/firefish.ts:1136

directStreaming

directStreaming(): Promise<WebSocketInterface>
Returns Promise<WebSocketInterface>
Implementation of MegalodonInterface.directStreaming
- Defined in megalodon/src/firefish.ts:2410

dismissInstanceAnnouncement

dismissInstanceAnnouncement(_id): Promise<Response<Record<never, never>>>
Dismiss an announcement.
Parameters
- _id: string
Returns Promise<Response<Record<never, never>>>
Implementation of MegalodonInterface.dismissInstanceAnnouncement
- Defined in megalodon/src/firefish.ts:2300

dismissNotification

dismissNotification(_id): Promise<Response<Record<never, never>>>
Dismiss a single notification.
Parameters
- _id: string
Returns Promise<Response<Record<never, never>>>
Implementation of MegalodonInterface.dismissNotification
- Defined in megalodon/src/firefish.ts:1936

dismissNotifications

dismissNotifications(): Promise<Response<Record<never, never>>>
POST /api/notifications/mark-all-as-read

Returns Promise<Response<Record<never, never>>>
Implementation of MegalodonInterface.dismissNotifications
- Defined in megalodon/src/firefish.ts:1932

editStatus

editStatus(_id, _options): Promise<Response<Status>>
Edit a given status to change its text, sensitivity, media attachments, or poll. Note that editing a poll’s options will reset the votes.
Parameters
- _id: string
- _options: {
      media_ids?: string[];
      poll?: {
          expires_in?: number;
          hide_totals?: boolean;
          multiple?: boolean;
          options?: string[];
      };
      sensitive?: boolean;
      spoiler_text?: string;
      status?: string;
  }
  - Optionalmedia_ids?: string[]
  - Optionalpoll?: {
        expires_in?: number;
        hide_totals?: boolean;
        multiple?: boolean;
        options?: string[];
    }
    - Optionalexpires_in?: number
    - Optionalhide_totals?: boolean
    - Optionalmultiple?: boolean
    - Optionaloptions?: string[]
  - Optionalsensitive?: boolean
  - Optionalspoiler_text?: string
  - Optionalstatus?: string
Returns Promise<Response<Status>>
Status
Implementation of MegalodonInterface.editStatus
- Defined in megalodon/src/firefish.ts:1117

favouriteStatus

favouriteStatus(id): Promise<Response<Status>>
POST /api/notes/favorites/create
Parameters
- id: string
Returns Promise<Response<Status>>
Implementation of MegalodonInterface.favouriteStatus
- Defined in megalodon/src/firefish.ts:1226

fetchAccessToken

fetchAccessToken(_client_id, client_secret, session_token, _redirect_uri?): Promise<TokenData>
POST /api/auth/session/userkey
Parameters
- _client_id: null | string
  This parameter is not used in this method.
- client_secret: string
  Application secret key which will be provided in createApp.
- session_token: string
  Session token string which will be provided in generateAuthUrlAndToken.
- Optional_redirect_uri: string
  This parameter is not used in this method.
Returns Promise<TokenData>
Implementation of MegalodonInterface.fetchAccessToken
- Defined in megalodon/src/firefish.ts:131

followAccount

followAccount(id, _options?): Promise<Response<Relationship>>
POST /api/following/create
Parameters
- id: string
- Optional_options: {
  reblog?: boolean;
  }
  - Optionalreblog?: boolean
Returns Promise<Response<Relationship>>
Implementation of MegalodonInterface.followAccount
- Defined in megalodon/src/firefish.ts:436

followTag

followTag(_id): Promise<Response<Tag>>
Follow a hashtag. Posts containing a followed hashtag will be inserted into your home timeline.
Parameters
- _id: string
Returns Promise<Response<Tag>>
Tag
Implementation of MegalodonInterface.followTag
- Defined in megalodon/src/firefish.ts:1019

generateAuthUrlAndToken

generateAuthUrlAndToken(clientSecret): Promise<Session>
POST /api/auth/session/generate
Parameters
- clientSecret: string
Returns Promise<Session>
- Defined in megalodon/src/firefish.ts:102

getAccount

getAccount(id): Promise<Response<Account>>
POST /api/users/show
Parameters
- id: string
Returns Promise<Response<Account>>
Implementation of MegalodonInterface.getAccount
- Defined in megalodon/src/firefish.ts:252

getAccountFavourites

getAccountFavourites(_id, _options?): Promise<Response<Status[]>>
Favourites timeline of any user.
Parameters
- _id: string
- Optional_options: {
      limit?: number;
      max_id?: string;
      since_id?: string;
  }
  - Optionallimit?: number
  - Optionalmax_id?: string
  - Optionalsince_id?: string
Returns Promise<Response<Status[]>>
Array of statuses.
Implementation of MegalodonInterface.getAccountFavourites
- Defined in megalodon/src/firefish.ts:335

getAccountFollowers

getAccountFollowers(id, options?): Promise<Response<Account[]>>
POST /api/users/followers
Parameters
- id: string
- Optionaloptions: {
      limit?: number;
      max_id?: string;
      since_id?: string;
  }
  - Optionallimit?: number
  - Optionalmax_id?: string
  - Optionalsince_id?: string
Returns Promise<Response<Account[]>>
Implementation of MegalodonInterface.getAccountFollowers
- Defined in megalodon/src/firefish.ts:366

getAccountFollowing

getAccountFollowing(id, options?): Promise<Response<Account[]>>
POST /api/users/following
Parameters
- id: string
- Optionaloptions: {
      limit?: number;
      max_id?: string;
      since_id?: string;
  }
  - Optionallimit?: number
  - Optionalmax_id?: string
  - Optionalsince_id?: string
Returns Promise<Response<Account[]>>
Implementation of MegalodonInterface.getAccountFollowing
- Defined in megalodon/src/firefish.ts:394

getAccountLists

getAccountLists(_id): Promise<Response<List[]>>
User lists that you have added this account to.
Parameters
- _id: string
Returns Promise<Response<List[]>>
The array of lists.
Implementation of MegalodonInterface.getAccountLists
- Defined in megalodon/src/firefish.ts:419

getAccountsInList

getAccountsInList(id, _options?): Promise<Response<Account[]>>
POST /api/users/lists/show
Parameters
- id: string
- Optional_options: {
      limit?: number;
      max_id?: string;
      since_id?: string;
  }
  - Optionallimit?: number
  - Optionalmax_id?: string
  - Optionalsince_id?: string
Returns Promise<Response<Account[]>>
Implementation of MegalodonInterface.getAccountsInList
- Defined in megalodon/src/firefish.ts:1808

getAccountStatuses

getAccountStatuses(id, options?): Promise<Response<Status[]>>
POST /api/users/notes
Parameters
- id: string
- Optionaloptions: {
      exclude_reblogs: boolean;
      exclude_replies: boolean;
      limit?: number;
      max_id?: string;
      only_media?: boolean;
      pinned?: boolean;
      since_id?: string;
  }
  - exclude_reblogs: boolean
  - exclude_replies: boolean
  - Optionallimit?: number
  - Optionalmax_id?: string
  - Optionalonly_media?: boolean
  - Optionalpinned?: boolean
  - Optionalsince_id?: string
Returns Promise<Response<Status[]>>
Implementation of MegalodonInterface.getAccountStatuses
- Defined in megalodon/src/firefish.ts:267

getBlocks

getBlocks(options?): Promise<Response<Account[]>>
POST /api/blocking/list
Parameters
- Optionaloptions: {
      limit?: number;
      max_id?: string;
      min_id?: string;
  }
  - Optionallimit?: number
  - Optionalmax_id?: string
  - Optionalmin_id?: string
Returns Promise<Response<Account[]>>
Implementation of MegalodonInterface.getBlocks
- Defined in megalodon/src/firefish.ts:719

getBookmarks

getBookmarks(_options?): Promise<Response<Status[]>>
Statuses the user has bookmarked.
Parameters
- Optional_options: {
      limit?: number;
      max_id?: string;
      min_id?: string;
      since_id?: string;
  }
  - Optionallimit?: number
  - Optionalmax_id?: string
  - Optionalmin_id?: string
  - Optionalsince_id?: string
Returns Promise<Response<Status[]>>
Array of statuses.
Implementation of MegalodonInterface.getBookmarks
- Defined in megalodon/src/firefish.ts:637

getConversationTimeline

getConversationTimeline(options?): Promise<Response<Conversation[]>>
POST /api/notes/mentions
Parameters
- Optionaloptions: {
      limit?: number;
      max_id?: string;
      min_id?: string;
      since_id?: string;
  }
  - Optionallimit?: number
  - Optionalmax_id?: string
  - Optionalmin_id?: string
  - Optionalsince_id?: string
Returns Promise<Response<Conversation[]>>
Implementation of MegalodonInterface.getConversationTimeline
- Defined in megalodon/src/firefish.ts:1700

getDomainBlocks

getDomainBlocks(_options?): Promise<Response<string[]>>
View domains the user has blocked.
Parameters
- Optional_options: {
      limit?: number;
      max_id?: string;
      min_id?: string;
  }
  - Optionallimit?: number
  - Optionalmax_id?: string
  - Optionalmin_id?: string
Returns Promise<Response<string[]>>
Array of domain name.
Implementation of MegalodonInterface.getDomainBlocks
- Defined in megalodon/src/firefish.ts:748

getEmojiReaction

getEmojiReaction(_id, _emoji): Promise<Response<Reaction>>
Get an object of emoji to account mappings with accounts that reacted to the post for a specific emoji.
Parameters
- _id: string
- _emoji: string
Returns Promise<Response<Reaction>>
Reaction.
Implementation of MegalodonInterface.getEmojiReaction
- Defined in megalodon/src/firefish.ts:2371

getEmojiReactions

getEmojiReactions(id): Promise<Response<Reaction[]>>
Get an object of emoji to account mappings with accounts that reacted to the post.
Parameters
- id: string
  Target status ID.
Returns Promise<Response<Reaction[]>>
Array of reaction.
Implementation of MegalodonInterface.getEmojiReactions
- Defined in megalodon/src/firefish.ts:2360

getEndorsements

getEndorsements(_options?): Promise<Response<Account[]>>
Accounts that the user is currently featuring on their profile.
Parameters
- Optional_options: {
      limit?: number;
      max_id?: string;
      since_id?: string;
  }
  - Optionallimit?: number
  - Optionalmax_id?: string
  - Optionalsince_id?: string
Returns Promise<Response<Account[]>>
Array of accounts.
Implementation of MegalodonInterface.getEndorsements
- Defined in megalodon/src/firefish.ts:915

getFavourites

getFavourites(options?): Promise<Response<Status[]>>
POST /api/i/favorites
Parameters
- Optionaloptions: {
      limit?: number;
      max_id?: string;
      min_id?: string;
  }
  - Optionallimit?: number
  - Optionalmax_id?: string
  - Optionalmin_id?: string
Returns Promise<Response<Status[]>>
Implementation of MegalodonInterface.getFavourites
- Defined in megalodon/src/firefish.ts:655

getFeaturedTags

getFeaturedTags(): Promise<Response<FeaturedTag[]>>
List all hashtags featured on your profile.

Returns Promise<Response<FeaturedTag[]>>
Array of featured tag.
Implementation of MegalodonInterface.getFeaturedTags
- Defined in megalodon/src/firefish.ts:929

getFilter

getFilter(_id): Promise<Response<Filter>>
Get a specyfic filter.
Parameters
- _id: string
Returns Promise<Response<Filter>>
Filter.
Implementation of MegalodonInterface.getFilter
- Defined in megalodon/src/firefish.ts:779

getFilters

getFilters(): Promise<Response<Filter[]>>
Get filters of the current user.

Returns Promise<Response<Filter[]>>
Array of filters.
Implementation of MegalodonInterface.getFilters
- Defined in megalodon/src/firefish.ts:772

getFollowedTags

getFollowedTags(): Promise<Response<Tag[]>>
View all followed tags.

Returns Promise<Response<Tag[]>>
Array of tag.
Implementation of MegalodonInterface.getFollowedTags
- Defined in megalodon/src/firefish.ts:984

getFollowRequests

getFollowRequests(_limit?): Promise<Response<Account[]>>
POST /api/following/requests/list
Parameters
- Optional_limit: number
Returns Promise<Response<Account[]>>
Implementation of MegalodonInterface.getFollowRequests
- Defined in megalodon/src/firefish.ts:868

getHomeTimeline

getHomeTimeline(options?): Promise<Response<Status[]>>
POST /api/notes/timeline
Parameters
- Optionaloptions: {
      limit?: number;
      local?: boolean;
      max_id?: string;
      min_id?: string;
      since_id?: string;
  }
  - Optionallimit?: number
  - Optionallocal?: boolean
  - Optionalmax_id?: string
  - Optionalmin_id?: string
  - Optionalsince_id?: string
Returns Promise<Response<Status[]>>
Implementation of MegalodonInterface.getHomeTimeline
- Defined in megalodon/src/firefish.ts:1614

getIdentityProof

getIdentityProof(_id): Promise<Response<IdentityProof[]>>
Returns an IdentityProof.
Parameters
- _id: string
Returns Promise<Response<IdentityProof[]>>
Array of IdentityProof
Implementation of MegalodonInterface.getIdentityProof
- Defined in megalodon/src/firefish.ts:426

getInstance

getInstance(): Promise<Response<Instance>>
POST /api/meta POST /api/stats

Returns Promise<Response<Instance>>
Implementation of MegalodonInterface.getInstance
- Defined in megalodon/src/firefish.ts:2227

getInstanceActivity

getInstanceActivity(): Promise<Response<Activity[]>>
Weekly activity.

Returns Promise<Response<Activity[]>>
Implementation of MegalodonInterface.getInstanceActivity
- Defined in megalodon/src/firefish.ts:2240

getInstanceAnnouncements

getInstanceAnnouncements(): Promise<Response<Announcement[]>>
GET /api/announcements

Returns Promise<Response<Announcement[]>>
Array of announcements.
Implementation of MegalodonInterface.getInstanceAnnouncements
- Defined in megalodon/src/firefish.ts:2294

getInstanceCustomEmojis

getInstanceCustomEmojis(): Promise<Response<Emoji[]>>
GET /api/meta

Returns Promise<Response<Emoji[]>>
Implementation of MegalodonInterface.getInstanceCustomEmojis
- Defined in megalodon/src/firefish.ts:2280

getInstanceDirectory

getInstanceDirectory(_options?): Promise<Response<Account[]>>
View profile directory.
Parameters
- Optional_options: {
      limit?: number;
      local?: boolean;
      offset?: number;
      order?: "active" | "new";
  }
  - Optionallimit?: number
  - Optionallocal?: boolean
  - Optionaloffset?: number
  - Optionalorder?: "active" | "new"
Returns Promise<Response<Account[]>>
Array of accounts.
Implementation of MegalodonInterface.getInstanceDirectory
- Defined in megalodon/src/firefish.ts:2262

getInstancePeers

getInstancePeers(): Promise<Response<string[]>>
List of connected domains.

Returns Promise<Response<string[]>>
Implementation of MegalodonInterface.getInstancePeers
- Defined in megalodon/src/firefish.ts:2233

getInstanceTrends

getInstanceTrends(_limit?): Promise<Response<Tag[]>>
POST /api/hashtags/trend
Parameters
- Optional_limit: null | number
Returns Promise<Response<Tag[]>>
Implementation of MegalodonInterface.getInstanceTrends
- Defined in megalodon/src/firefish.ts:2253

getList

getList(id): Promise<Response<List>>
POST /api/users/lists/show
Parameters
- id: string
Returns Promise<Response<List>>
Implementation of MegalodonInterface.getList
- Defined in megalodon/src/firefish.ts:1765

getLists

getLists(): Promise<Response<List[]>>
POST /api/users/lists/list

Returns Promise<Response<List[]>>
Implementation of MegalodonInterface.getLists
- Defined in megalodon/src/firefish.ts:1756

getListTimeline

getListTimeline(list_id, options?): Promise<Response<Status[]>>
POST /api/notes/user-list-timeline
Parameters
- list_id: string
- Optionaloptions: {
      limit?: number;
      max_id?: string;
      min_id?: string;
      since_id?: string;
  }
  - Optionallimit?: number
  - Optionalmax_id?: string
  - Optionalmin_id?: string
  - Optionalsince_id?: string
Returns Promise<Response<Status[]>>
Implementation of MegalodonInterface.getListTimeline
- Defined in megalodon/src/firefish.ts:1654

getLocalTimeline

getLocalTimeline(options?): Promise<Response<Status[]>>
POST /api/notes/local-timeline
Parameters
- Optionaloptions: {
      limit?: number;
      max_id?: string;
      min_id?: string;
      only_media?: boolean;
      since_id?: string;
  }
  - Optionallimit?: number
  - Optionalmax_id?: string
  - Optionalmin_id?: string
  - Optionalonly_media?: boolean
  - Optionalsince_id?: string
Returns Promise<Response<Status[]>>
Implementation of MegalodonInterface.getLocalTimeline
- Defined in megalodon/src/firefish.ts:1522

getMarkers

getMarkers(_timeline): Promise<Response<Marker | Record<never, never>>>
Get saved timeline positions.
Parameters
- _timeline: string[]
Returns Promise<Response<Marker | Record<never, never>>>
Marker or empty object.
Implementation of MegalodonInterface.getMarkers
- Defined in megalodon/src/firefish.ts:1851

getMedia

getMedia(id): Promise<Response<Attachment>>
Get media attachment.
Parameters
- id: string
  Target media ID.
Returns Promise<Response<Attachment>>
Attachment
Implementation of MegalodonInterface.getMedia
- Defined in megalodon/src/firefish.ts:1363

getMutes

getMutes(options?): Promise<Response<Account[]>>
POST /api/mute/list
Parameters
- Optionaloptions: {
      limit?: number;
      max_id?: string;
      min_id?: string;
  }
  - Optionallimit?: number
  - Optionalmax_id?: string
  - Optionalmin_id?: string
Returns Promise<Response<Account[]>>
Implementation of MegalodonInterface.getMutes
- Defined in megalodon/src/firefish.ts:687

getNotification

getNotification(_id): Promise<Response<Notification>>
Get a single notification.
Parameters
- _id: string
Returns Promise<Response<Notification>>
Notification.
Implementation of MegalodonInterface.getNotification
- Defined in megalodon/src/firefish.ts:1922

getNotifications

getNotifications(options?): Promise<Response<Notification[]>>
POST /api/i/notifications
Parameters
- Optionaloptions: {
      account_id?: string;
      exclude_type?: string[];
      limit?: number;
      max_id?: string;
      min_id?: string;
      since_id?: string;
  }
  - Optionalaccount_id?: string
  - Optionalexclude_type?: string[]
  - Optionallimit?: number
  - Optionalmax_id?: string
  - Optionalmin_id?: string
  - Optionalsince_id?: string
Returns Promise<Response<Notification[]>>
Implementation of MegalodonInterface.getNotifications
- Defined in megalodon/src/firefish.ts:1874

getPoll

getPoll(_id): Promise<Response<Poll>>
View a poll.
Parameters
- _id: string
Returns Promise<Response<Poll>>
Poll
Implementation of MegalodonInterface.getPoll
- Defined in megalodon/src/firefish.ts:1398

getPreferences

getPreferences(): Promise<Response<Preferences>>
Get preferences defined by the user in their account settings.

Returns Promise<Response<Preferences>>
Preferences.
Implementation of MegalodonInterface.getPreferences
- Defined in megalodon/src/firefish.ts:960

getPublicTimeline

getPublicTimeline(options?): Promise<Response<Status[]>>
POST /api/notes/global-timeline
Parameters
- Optionaloptions: {
      limit?: number;
      max_id?: string;
      min_id?: string;
      only_media?: boolean;
      since_id?: string;
  }
  - Optionallimit?: number
  - Optionalmax_id?: string
  - Optionalmin_id?: string
  - Optionalonly_media?: boolean
  - Optionalsince_id?: string
Returns Promise<Response<Status[]>>
Implementation of MegalodonInterface.getPublicTimeline
- Defined in megalodon/src/firefish.ts:1479

getPushSubscription

getPushSubscription(): Promise<Response<PushSubscription>>
Get current subscription.

Returns Promise<Response<PushSubscription>>
PushSubscription.
Implementation of MegalodonInterface.getPushSubscription
- Defined in megalodon/src/firefish.ts:1963

getRelationship

getRelationship(id): Promise<Response<Relationship>>
POST /api/users/relation
Parameters
- id: string
  The accountID, for example '1sdfag'
Returns Promise<Response<Relationship>>
Implementation of MegalodonInterface.getRelationship
- Defined in megalodon/src/firefish.ts:567

getRelationships

getRelationships(ids): Promise<Response<Relationship[]>>
POST /api/users/relation
Parameters
- ids: string[]
Returns Promise<Response<Relationship[]>>
Implementation of MegalodonInterface.getRelationships
- Defined in megalodon/src/firefish.ts:584

getScheduledStatus

getScheduledStatus(_id): Promise<Response<ScheduledStatus>>
View a single scheduled status.
Parameters
- _id: string
Returns Promise<Response<ScheduledStatus>>
ScheduledStatus.
Implementation of MegalodonInterface.getScheduledStatus
- Defined in megalodon/src/firefish.ts:1452

getScheduledStatuses

getScheduledStatuses(_options?): Promise<Response<ScheduledStatus[]>>
View scheduled statuses.
Parameters
- Optional_options: {
      limit?: number;
      max_id?: string;
      min_id?: string;
      since_id?: string;
  }
  - Optionallimit?: number
  - Optionalmax_id?: string
  - Optionalmin_id?: string
  - Optionalsince_id?: string
Returns Promise<Response<ScheduledStatus[]>>
Array of scheduled statuses.
Implementation of MegalodonInterface.getScheduledStatuses
- Defined in megalodon/src/firefish.ts:1440

getStatus

getStatus(id): Promise<Response<Status>>
POST /api/notes/show
Parameters
- id: string
Returns Promise<Response<Status>>
Implementation of MegalodonInterface.getStatus
- Defined in megalodon/src/firefish.ts:1109

getStatusContext

getStatusContext(id, options?): Promise<Response<Context>>
POST /api/notes/children
Parameters
- id: string
- Optionaloptions: {
      limit?: number;
      max_id?: string;
      since_id?: string;
  }
  - Optionallimit?: number
  - Optionalmax_id?: string
  - Optionalsince_id?: string
Returns Promise<Response<Context>>
Implementation of MegalodonInterface.getStatusContext
- Defined in megalodon/src/firefish.ts:1145

getStatusFavouritedBy

getStatusFavouritedBy(_id): Promise<Response<Account[]>>
See who favourited a status
Parameters
- _id: string
Returns Promise<Response<Account[]>>
Array of accounts.
Implementation of MegalodonInterface.getStatusFavouritedBy
- Defined in megalodon/src/firefish.ts:1216

getStatusRebloggedBy

getStatusRebloggedBy(id): Promise<Response<Account[]>>
POST /api/notes/renotes
Parameters
- id: string
Returns Promise<Response<Account[]>>
Implementation of MegalodonInterface.getStatusRebloggedBy
- Defined in megalodon/src/firefish.ts:1205

getStatusSource

getStatusSource(_id): Promise<Response<StatusSource>>
View status source. Obtain the source properties for a status so that it can be edited.
Parameters
- _id: string
Returns Promise<Response<StatusSource>>
StatusSource
Implementation of MegalodonInterface.getStatusSource
- Defined in megalodon/src/firefish.ts:1195

getSuggestedTags

getSuggestedTags(): Promise<Response<Tag[]>>
Shows up to 10 recently-used tags.

Returns Promise<Response<Tag[]>>
Array of tag.
Implementation of MegalodonInterface.getSuggestedTags
- Defined in megalodon/src/firefish.ts:950

getSuggestions

getSuggestions(limit?): Promise<Response<Account[]>>
POST /api/users/recommendation
Parameters
- Optionallimit: number
Returns Promise<Response<Account[]>>
Implementation of MegalodonInterface.getSuggestions
- Defined in megalodon/src/firefish.ts:997

getTag

getTag(_id): Promise<Response<Tag>>
Show a hashtag and its associated information
Parameters
- _id: string
Returns Promise<Response<Tag>>
Tag
Implementation of MegalodonInterface.getTag
- Defined in megalodon/src/firefish.ts:1012

getTagTimeline

getTagTimeline(hashtag, options?): Promise<Response<Status[]>>
POST /api/notes/search-by-tag
Parameters
- hashtag: string
- Optionaloptions: {
      limit?: number;
      local?: boolean;
      max_id?: string;
      min_id?: string;
      only_media?: boolean;
      since_id?: string;
  }
  - Optionallimit?: number
  - Optionallocal?: boolean
  - Optionalmax_id?: string
  - Optionalmin_id?: string
  - Optionalonly_media?: boolean
  - Optionalsince_id?: string
Returns Promise<Response<Status[]>>
Implementation of MegalodonInterface.getTagTimeline
- Defined in megalodon/src/firefish.ts:1565

listStreaming

listStreaming(list_id): Promise<WebSocketInterface>
Parameters
- list_id: string
Returns Promise<WebSocketInterface>
Implementation of MegalodonInterface.listStreaming
- Defined in megalodon/src/firefish.ts:2405

localStreaming

localStreaming(): Promise<WebSocketInterface>
Returns Promise<WebSocketInterface>
Implementation of MegalodonInterface.localStreaming
- Defined in megalodon/src/firefish.ts:2396

lookupAccount

lookupAccount(_acct): Promise<Response<Account>>
Lookup account ID from Webfinger address.
Parameters
- _acct: string
Returns Promise<Response<Account>>
Account
Implementation of MegalodonInterface.lookupAccount
- Defined in megalodon/src/firefish.ts:627

muteAccount

muteAccount(id, _notifications): Promise<Response<Relationship>>
POST /api/mute/create
Parameters
- id: string
- _notifications: boolean
Returns Promise<Response<Relationship>>
Implementation of MegalodonInterface.muteAccount
- Defined in megalodon/src/firefish.ts:508

muteStatus

muteStatus(_id): Promise<Response<Status>>
Mute a conversation.
Parameters
- _id: string
Returns Promise<Response<Status>>
Status
Implementation of MegalodonInterface.muteStatus
- Defined in megalodon/src/firefish.ts:1290

pinAccount

pinAccount(_id): Promise<Response<Relationship>>
Add the given account to the user’s featured profiles.
Parameters
- _id: string
Returns Promise<Response<Relationship>>
Relationship
Implementation of MegalodonInterface.pinAccount
- Defined in megalodon/src/firefish.ts:541

pinStatus

pinStatus(id): Promise<Response<Status>>
POST /api/i/pin
Parameters
- id: string
Returns Promise<Response<Status>>
Implementation of MegalodonInterface.pinStatus
- Defined in megalodon/src/firefish.ts:1307

postStatus

postStatus(status, options?): Promise<Response<Status>>
Publish a status with the given parameters.
Parameters
- status: string
  Text content of status.
- Optionaloptions: {
      in_reply_to_id?: string;
      language?: string;
      media_ids?: string[];
      poll?: {
          expires_in: number;
          hide_totals?: boolean;
          multiple?: boolean;
          options: string[];
      };
      quote_id?: string;
      scheduled_at?: string;
      sensitive?: boolean;
      spoiler_text?: string;
      visibility?: StatusVisibility;
  }
  - Optionalin_reply_to_id?: string
    ID of the status being replied to, if status is a reply.
  - Optionallanguage?: string
    ISO 639 language code for this status.
  - Optionalmedia_ids?: string[]
    Array of Attachment ids.
  - Optionalpoll?: {
        expires_in: number;
        hide_totals?: boolean;
        multiple?: boolean;
        options: string[];
    }
    Poll object.
    - expires_in: number
    - Optionalhide_totals?: boolean
    - Optionalmultiple?: boolean
    - options: string[]
  - Optionalquote_id?: string
    ID of the status being quoted to, if status is a quote.
  - Optionalscheduled_at?: string
    ISO 8601 Datetime at which to schedule a status.
  - Optionalsensitive?: boolean
    Mark status and attached media as sensitive?
  - Optionalspoiler_text?: string
    Text to be shown as a warning or subject before the actual content.
  - Optionalvisibility?: StatusVisibility
    Visibility of the posted status.
Returns Promise<Response<Status>>
Status. When options.scheduled_at is present, ScheduledStatus is returned instead.
Implementation of MegalodonInterface.postStatus
- Defined in megalodon/src/firefish.ts:1036

publicStreaming

publicStreaming(): Promise<WebSocketInterface>
Returns Promise<WebSocketInterface>
Implementation of MegalodonInterface.publicStreaming
- Defined in megalodon/src/firefish.ts:2391

readConversation

readConversation(_id): Promise<Response<Conversation>>
Mark a conversation as read.
Parameters
- _id: string
Returns Promise<Response<Conversation>>
Conversation.
Implementation of MegalodonInterface.readConversation
- Defined in megalodon/src/firefish.ts:1743

readNotifications

readNotifications(_options): Promise<Response<{}>>
Mark as read all unread notifications.
Parameters
- _options: {
  id?: string;
  max_id?: string;
  }
  - Optionalid?: string
  - Optionalmax_id?: string
Returns Promise<Response<{}>>
Implementation of MegalodonInterface.readNotifications
- Defined in megalodon/src/firefish.ts:1943

reblogStatus

reblogStatus(id): Promise<Response<Status>>
POST /api/notes/create
Parameters
- id: string
Returns Promise<Response<Status>>
Implementation of MegalodonInterface.reblogStatus
- Defined in megalodon/src/firefish.ts:1254

refreshToken

refreshToken(_client_id, _client_secret, _refresh_token): Promise<TokenData>
Refresh OAuth access token. Send refresh token and get new access token.
Parameters
- _client_id: string
- _client_secret: string
- _refresh_token: string
Returns Promise<TokenData>
Implementation of MegalodonInterface.refreshToken
- Defined in megalodon/src/firefish.ts:147

registerAccount

registerAccount(_username, _email, _password, _agreement, _locale, _reason?): Promise<Response<Token>>
Creates a user and account records. Returns an account access token for the app that initiated the request. The app should save this token for later, and should wait for the user to confirm their account by clicking a link in their email inbox.
Parameters
- _username: string
- _email: string
- _password: string
- _agreement: boolean
- _locale: string
- Optional_reason: null | string
Returns Promise<Response<Token>>
An account token.
Implementation of MegalodonInterface.registerAccount
- Defined in megalodon/src/firefish.ts:164

registerApp

registerApp(client_name, options?): Promise<AppData>
First, call createApp to get client_id and client_secret. Next, call generateAuthUrl to get authorization url.
Parameters
- client_name: string
  Form Data, which is sent to /api/v1/apps
- options: Partial<{
      redirect_uris: string;
      scopes: string[];
      website: string;
  }> = ...
  Form Data, which is sent to /api/v1/apps. and properties should be snake_case
Returns Promise<AppData>
Implementation of MegalodonInterface.registerApp
- Defined in megalodon/src/firefish.ts:37

rejectFollowRequest

rejectFollowRequest(id): Promise<Response<Relationship>>
POST /api/following/requests/reject
Parameters
- id: string
Returns Promise<Response<Relationship>>
Implementation of MegalodonInterface.rejectFollowRequest
- Defined in megalodon/src/firefish.ts:897

removeReactionFromAnnouncement

removeReactionFromAnnouncement(_id, _name): Promise<Response<Record<never, never>>>
Remove a reaction from an announcement.
Parameters
- _id: string
- _name: string
Returns Promise<Response<Record<never, never>>>
Implementation of MegalodonInterface.removeReactionFromAnnouncement
- Defined in megalodon/src/firefish.ts:2314

report

report(account_id, options): Promise<Response<Report>>
POST /api/users/report-abuse
Parameters
- account_id: string
- options: {
      category: Category;
      comment: string;
      forward?: boolean;
      rule_ids?: number[];
      status_ids?: string[];
  }
  - category: Category
  - comment: string
  - Optionalforward?: boolean
  - Optionalrule_ids?: number[]
  - Optionalstatus_ids?: string[]
Returns Promise<Response<Report>>
Implementation of MegalodonInterface.report
- Defined in megalodon/src/firefish.ts:830

revokeToken

revokeToken(_client_id, _client_secret, _token): Promise<Response<Record<never, never>>>
Revoke an OAuth token.
Parameters
- _client_id: string
- _client_secret: string
- _token: string
Returns Promise<Response<Record<never, never>>>
Implementation of MegalodonInterface.revokeToken
- Defined in megalodon/src/firefish.ts:154

saveMarkers

saveMarkers(_options?): Promise<Response<Marker>>
Save your position in a timeline.
Parameters
- Optional_options: {
      home?: {
          last_read_id: string;
      };
      notifications?: {
          last_read_id: string;
      };
  }
  - Optionalhome?: {
    last_read_id: string;
    }
    - last_read_id: string
  - Optionalnotifications?: {
    last_read_id: string;
    }
    - last_read_id: string
Returns Promise<Response<Marker>>
Marker.
Implementation of MegalodonInterface.saveMarkers
- Defined in megalodon/src/firefish.ts:1858

scheduleStatus

scheduleStatus(_id, _scheduled_at?): Promise<Response<ScheduledStatus>>
Update a scheduled status’s publishing date.
Parameters
- _id: string
- Optional_scheduled_at: null | string
Returns Promise<Response<ScheduledStatus>>
ScheduledStatus.
Implementation of MegalodonInterface.scheduleStatus
- Defined in megalodon/src/firefish.ts:1459

search

search(q, options?): Promise<Response<Results>>
Perform a search.
Parameters
- q: string
  The search query.
- Optionaloptions: {
      account_id?: string;
      exclude_unreviewed?: boolean;
      following?: boolean;
      limit?: number;
      max_id?: string;
      min_id?: string;
      offset?: number;
      resolve?: boolean;
      type: "accounts" | "hashtags" | "statuses";
  }
  - Optionalaccount_id?: string
    If provided, statuses returned will be authored only by this account.
  - Optionalexclude_unreviewed?: boolean
    Filter out unreviewed tags? Defaults to false.
  - Optionalfollowing?: boolean
    Only include accounts that the user is following. Defaults to false.
  - Optionallimit?: number
    Maximum number of results to load, per type. Defaults to 20. Max 40.
  - Optionalmax_id?: string
    Return results older than this id.
  - Optionalmin_id?: string
    Return results immediately newer than this id.
  - Optionaloffset?: number
  - Optionalresolve?: boolean
    Attempt WebFinger lookup. Defaults to false.
  - type: "accounts" | "hashtags" | "statuses"
    Enum of search target.
Returns Promise<Response<Results>>
Results.
Implementation of MegalodonInterface.search
- Defined in megalodon/src/firefish.ts:2156

searchAccount

searchAccount(q, options?): Promise<Response<Account[]>>
POST /api/users/search
Parameters
- q: string
- Optionaloptions: {
      following?: boolean;
      limit?: number;
      max_id?: string;
      resolve?: boolean;
      since_id?: string;
  }
  - Optionalfollowing?: boolean
  - Optionallimit?: number
  - Optionalmax_id?: string
  - Optionalresolve?: boolean
  - Optionalsince_id?: string
Returns Promise<Response<Account[]>>
Implementation of MegalodonInterface.searchAccount
- Defined in megalodon/src/firefish.ts:594

setAccountNote

setAccountNote(_id): Promise<Response<Relationship>>
Sets a private note on a user.
Parameters
- _id: string
Returns Promise<Response<Relationship>>
Relationship
Implementation of MegalodonInterface.setAccountNote
- Defined in megalodon/src/firefish.ts:555

streamingURL

streamingURL(): Promise<string>
Returns Promise<string>
Implementation of MegalodonInterface.streamingURL
- Defined in megalodon/src/firefish.ts:2378

subscribeAccount

subscribeAccount(_id): Promise<Response<Relationship>>
Subscribe to receive notifications for all statuses posted by a user.
Parameters
- _id: string
Returns Promise<Response<Relationship>>
Relationship.
Implementation of MegalodonInterface.subscribeAccount
- Defined in megalodon/src/firefish.ts:349

subscribePushNotification

subscribePushNotification(_subscription, _data?): Promise<Response<PushSubscription>>
Subscribe to push notifications.
Parameters
- _subscription: {
      endpoint: string;
      keys: {
          auth: string;
          p256dh: string;
      };
  }
  - endpoint: string
  - keys: {
    auth: string;
    p256dh: string;
    }
    - auth: string
    - p256dh: string
- Optional_data: null | {
      alerts: {
          favourite?: boolean;
          follow?: boolean;
          mention?: boolean;
          poll?: boolean;
          reblog?: boolean;
      };
  }
Returns Promise<Response<PushSubscription>>
PushSubscription.
Implementation of MegalodonInterface.subscribePushNotification
- Defined in megalodon/src/firefish.ts:1953

tagStreaming

tagStreaming(_tag): Promise<WebSocketInterface>
Parameters
- _tag: string
Returns Promise<WebSocketInterface>
Implementation of MegalodonInterface.tagStreaming
- Defined in megalodon/src/firefish.ts:2401

unblockAccount

unblockAccount(id): Promise<Response<Relationship>>
POST /api/blocking/delete
Parameters
- id: string
Returns Promise<Response<Relationship>>
Implementation of MegalodonInterface.unblockAccount
- Defined in megalodon/src/firefish.ts:490

unblockDomain

unblockDomain(_domain): Promise<Response<Record<never, never>>>
Remove a domain block, if it exists in the user’s array of blocked domains.
Parameters
- _domain: string
Returns Promise<Response<Record<never, never>>>
Implementation of MegalodonInterface.unblockDomain
- Defined in megalodon/src/firefish.ts:762

unbookmarkStatus

unbookmarkStatus(_id): Promise<Response<Status>>
Undo bookmark of a status.
Parameters
- _id: string
Returns Promise<Response<Status>>
Status.
Implementation of MegalodonInterface.unbookmarkStatus
- Defined in megalodon/src/firefish.ts:1283

unfavouriteStatus

unfavouriteStatus(id): Promise<Response<Status>>
POST /api/notes/favorites/delete
Parameters
- id: string
Returns Promise<Response<Status>>
Implementation of MegalodonInterface.unfavouriteStatus
- Defined in megalodon/src/firefish.ts:1240

unfollowAccount

unfollowAccount(id): Promise<Response<Relationship>>
POST /api/following/delete
Parameters
- id: string
Returns Promise<Response<Relationship>>
Implementation of MegalodonInterface.unfollowAccount
- Defined in megalodon/src/firefish.ts:454

unfollowTag

unfollowTag(_id): Promise<Response<Tag>>
Unfollow a hashtag. Posts containing this hashtag will no longer be inserted into your home timeline.
Parameters
- _id: string
Returns Promise<Response<Tag>>
Tag
Implementation of MegalodonInterface.unfollowTag
- Defined in megalodon/src/firefish.ts:1026

unmuteAccount

unmuteAccount(id): Promise<Response<Relationship>>
POST /api/mute/delete
Parameters
- id: string
Returns Promise<Response<Relationship>>
Implementation of MegalodonInterface.unmuteAccount
- Defined in megalodon/src/firefish.ts:526

unmuteStatus

unmuteStatus(_id): Promise<Response<Status>>
Unmute a conversation.
Parameters
- _id: string
Returns Promise<Response<Status>>
Status
Implementation of MegalodonInterface.unmuteStatus
- Defined in megalodon/src/firefish.ts:1297

unpinAccount

unpinAccount(_id): Promise<Response<Relationship>>
Remove the given account from the user’s featured profiles.
Parameters
- _id: string
Returns Promise<Response<Relationship>>
Relationship
Implementation of MegalodonInterface.unpinAccount
- Defined in megalodon/src/firefish.ts:548

unpinStatus

unpinStatus(id): Promise<Response<Status>>
POST /api/i/unpin
Parameters
- id: string
Returns Promise<Response<Status>>
Implementation of MegalodonInterface.unpinStatus
- Defined in megalodon/src/firefish.ts:1321

unreblogStatus

unreblogStatus(id): Promise<Response<Status>>
POST /api/notes/unrenote
Parameters
- id: string
Returns Promise<Response<Status>>
Implementation of MegalodonInterface.unreblogStatus
- Defined in megalodon/src/firefish.ts:1265

unsubscribeAccount

unsubscribeAccount(_id): Promise<Response<Relationship>>
Unsubscribe to stop receiving notifications from user statuses.
Parameters
- _id: string
Returns Promise<Response<Relationship>>
Relationship.
Implementation of MegalodonInterface.unsubscribeAccount
- Defined in megalodon/src/firefish.ts:356

updateCredentials

updateCredentials(options?): Promise<Response<Account>>
POST /api/i/update
Parameters
- Optionaloptions: {
      avatar?: string;
      bot?: boolean;
      discoverable?: boolean;
      display_name?: string;
      fields_attributes?: {
          name: string;
          value: string;
      }[];
      header?: string;
      locked?: boolean;
      note?: string;
      source?: null | {
          language?: string;
          privacy?: string;
          sensitive?: boolean;
      };
  }
  - Optionalavatar?: string
  - Optionalbot?: boolean
  - Optionaldiscoverable?: boolean
  - Optionaldisplay_name?: string
  - Optionalfields_attributes?: {
    name: string;
    value: string;
    }[]
  - Optionalheader?: string
  - Optionallocked?: boolean
  - Optionalnote?: string
  - Optionalsource?: null | {
        language?: string;
        privacy?: string;
        sensitive?: boolean;
    }
Returns Promise<Response<Account>>
Implementation of MegalodonInterface.updateCredentials
- Defined in megalodon/src/firefish.ts:192

updateFilter

updateFilter(_id, _phrase, _context, _options?): Promise<Response<Filter>>
Replaces a filter’s parameters in-place.
Parameters
- _id: string
- _phrase: string
- _context: string[]
- Optional_options: {
      expires_in?: string;
      irreversible?: boolean;
      whole_word?: boolean;
  }
  - Optionalexpires_in?: string
  - Optionalirreversible?: boolean
  - Optionalwhole_word?: boolean
Returns Promise<Response<Filter>>
Filter
Implementation of MegalodonInterface.updateFilter
- Defined in megalodon/src/firefish.ts:801

updateList

updateList(id, title): Promise<Response<List>>
POST /api/users/lists/update
Parameters
- id: string
- title: string
Returns Promise<Response<List>>
Implementation of MegalodonInterface.updateList
- Defined in megalodon/src/firefish.ts:1787

updateMedia

updateMedia(id, options?): Promise<Response<Attachment>>
POST /api/drive/files/update
Parameters
- id: string
- Optionaloptions: {
      description?: string;
      file?: any;
      focus?: string;
      is_sensitive?: boolean;
  }
  - Optionaldescription?: string
  - Optionalfile?: any
  - Optionalfocus?: string
  - Optionalis_sensitive?: boolean
Returns Promise<Response<Attachment>>
Implementation of MegalodonInterface.updateMedia
- Defined in megalodon/src/firefish.ts:1371

updatePushSubscription

updatePushSubscription(_data?): Promise<Response<PushSubscription>>
Change types of notifications.
Parameters
- Optional_data: null | {
      alerts: {
          favourite?: boolean;
          follow?: boolean;
          mention?: boolean;
          poll?: boolean;
          reblog?: boolean;
      };
  }
Returns Promise<Response<PushSubscription>>
PushSubscription.
Implementation of MegalodonInterface.updatePushSubscription
- Defined in megalodon/src/firefish.ts:1970

uploadMedia

uploadMedia(file, _options?): Promise<Response<Attachment>>
POST /api/drive/files/create
Parameters
- file: any
- Optional_options: {
  description?: string;
  focus?: string;
  }
  - Optionaldescription?: string
  - Optionalfocus?: string
Returns Promise<Response<Attachment>>
Implementation of MegalodonInterface.uploadMedia
- Defined in megalodon/src/firefish.ts:1351

userStreaming

userStreaming(): Promise<WebSocketInterface>
Returns Promise<WebSocketInterface>
Implementation of MegalodonInterface.userStreaming
- Defined in megalodon/src/firefish.ts:2386

verifyAccountCredentials

verifyAccountCredentials(): Promise<Response<Account>>
POST /api/i

Returns Promise<Response<Account>>
Implementation of MegalodonInterface.verifyAccountCredentials
- Defined in megalodon/src/firefish.ts:181

verifyAppCredentials

verifyAppCredentials(): Promise<Response<Application>>
Verify the app works.

Returns Promise<Response<Application>>
An Application
Implementation of MegalodonInterface.verifyAppCredentials
- Defined in megalodon/src/firefish.ts:113

votePoll

votePoll(_id, choices, status_id?): Promise<Response<Poll>>
POST /api/notes/polls/vote
Parameters
- _id: string
- choices: number[]
- Optionalstatus_id: null | string
Returns Promise<Response<Poll>>
Implementation of MegalodonInterface.votePoll
- Defined in megalodon/src/firefish.ts:1408

Class Firefish

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns Firefish

Properties

baseUrl

client

Methods

acceptFollowRequest

Parameters

Returns Promise<Response<Relationship>>

addAccountsToList

Parameters

Returns Promise<Response<Record<never, never>>>

addReactionToAnnouncement

Parameters

Returns Promise<Response<Record<never, never>>>

blockAccount

Parameters

Returns Promise<Response<Relationship>>

blockDomain

Parameters

Returns Promise<Response<Record<never, never>>>

bookmarkStatus

Parameters

Returns Promise<Response<Status>>

cancel

Returns void

cancelScheduledStatus

Parameters

Returns Promise<Response<Record<never, never>>>

createApp

Parameters

Returns Promise<AppData>

createEmojiReaction

Parameters

Returns Promise<Response<Status>>

createFeaturedTag

Parameters

Returns Promise<Response<FeaturedTag>>

createFilter

Parameters

Optionalexpires_in?: string

Optionalirreversible?: boolean

Optionalwhole_word?: boolean

Returns Promise<Response<Filter>>

createList

Parameters

Returns Promise<Response<List>>

deleteAccountsFromList

Parameters

Returns Promise<Response<Record<never, never>>>

deleteConversation

Parameters

Returns Promise<Response<Record<never, never>>>

deleteEmojiReaction

Parameters

Returns Promise<Response<Status>>

deleteFeaturedTag

Parameters

Returns Promise<Response<Record<never, never>>>

deleteFilter

Parameters

Returns Promise<Response<Filter>>

deleteList

Parameters

Returns Promise<Response<Record<never, never>>>

deletePushSubscription

Returns Promise<Response<Record<never, never>>>

deleteStatus

Parameters

Returns Promise<Response<Record<never, never>>>

directStreaming

Returns Promise<WebSocketInterface>

`Optional`expires_in?: string

`Optional`irreversible?: boolean

`Optional`whole_word?: boolean

`Optional`media_ids?: string[]

`Optional`poll?: {
expires_in?: number;
hide_totals?: boolean;
multiple?: boolean;
options?: string[];
}

`Optional`expires_in?: number

`Optional`hide_totals?: boolean

`Optional`multiple?: boolean

`Optional`options?: string[]

`Optional`sensitive?: boolean

`Optional`spoiler_text?: string

`Optional`status?: string

`Optional`reblog?: boolean

`Optional`limit?: number

`Optional`max_id?: string

`Optional`since_id?: string

`Optional`limit?: number

`Optional`max_id?: string

`Optional`since_id?: string

`Optional`limit?: number

`Optional`max_id?: string

`Optional`since_id?: string

`Optional`limit?: number

`Optional`max_id?: string

`Optional`since_id?: string