Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Pleroma

Hierarchy

  • Pleroma

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

  • new Pleroma(baseUrl: string, accessToken?: null | string, userAgent?: null | string, proxyConfig?: false | ProxyConfig): Pleroma
  • 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.

    • proxyConfig: false | ProxyConfig = false

      Proxy setting, or set false if don't use proxy.

    Returns Pleroma

Properties

baseUrl

baseUrl: string

client

client: Interface

Methods

acceptFollowRequest

addAccountsToList

  • addAccountsToList(id: string, account_ids: string[]): Promise<Response<{}>>

blockAccount

blockDomain

  • blockDomain(domain: string): Promise<Response<{}>>

bookmarkStatus

cancel

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

    Returns void

    void

cancelScheduledStatus

  • cancelScheduledStatus(id: string): Promise<Response<{}>>

createApp

  • createApp(client_name: string, options: Partial<{ redirect_uris: string; scopes: string[]; website: string }>): Promise<AppData>
  • Call /api/v1/apps

    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>

createEmojiReaction

  • PUT /api/v1/pleroma/statuses/:status_id/reactions/:emoji

    Parameters

    • id: string

      Target status ID.

    • emoji: string

      Reaction emoji string. This string is raw unicode emoji.

    Returns Promise<Response<Entity.Status>>

createFeaturedTag

createFilter

  • createFilter(phrase: string, context: string[], options?: { expires_in?: string; irreversible?: boolean; whole_word?: boolean }): Promise<Response<Filter>>
  • POST /api/v1/filters

    Parameters

    • phrase: string
    • context: string[]
    • Optional options: { expires_in?: string; irreversible?: boolean; whole_word?: boolean }
      • Optional expires_in?: string
      • Optional irreversible?: boolean
      • Optional whole_word?: boolean

    Returns Promise<Response<Filter>>

    Filter

createList

deleteAccountsFromList

  • deleteAccountsFromList(id: string, account_ids: string[]): Promise<Response<{}>>

deleteConversation

  • deleteConversation(id: string): Promise<Response<{}>>

deleteEmojiReaction

  • DELETE /api/v1/pleroma/statuses/:status_id/reactions/:emoji

    Parameters

    • id: string

      Target status ID.

    • emoji: string

      Reaction emoji string. This string is raw unicode emoji.

    Returns Promise<Response<Entity.Status>>

deleteFeaturedTag

  • deleteFeaturedTag(id: string): Promise<Response<{}>>

deleteFilter

deleteList

  • deleteList(id: string): Promise<Response<{}>>

deletePushSubscription

  • deletePushSubscription(): Promise<Response<{}>>

deleteStatus

directSocket

  • directSocket(): default

directStream

dismissNotification

  • dismissNotification(id: string): Promise<Response<{}>>

dismissNotifications

  • dismissNotifications(): Promise<Response<{}>>

favouriteStatus

fetchAccessToken

  • fetchAccessToken(client_id: null | string, client_secret: string, code: string, redirect_uri?: string): Promise<TokenData>
  • POST /oauth/token

    Fetch OAuth access token. Get an access token based client_id and client_secret and authorization code.

    Parameters

    • client_id: null | string
    • client_secret: string
    • code: string
    • redirect_uri: string = NO_REDIRECT

    Returns Promise<TokenData>

followAccount

  • POST /api/v1/accounts/:id/follow

    Parameters

    • id: string
    • Optional options: { reblog?: boolean }
      • Optional reblog?: boolean

    Returns Promise<Response<Relationship>>

    Relationship

generateAuthUrl

  • generateAuthUrl(clientId: string, clientSecret: string, options: Partial<{ redirect_uri: string; scope: string[] }>): Promise<string>
  • Generate authorization url using OAuth2.

    Parameters

    • clientId: string

      your OAuth app's client ID

    • clientSecret: string

      your OAuth app's client Secret

    • options: Partial<{ redirect_uri: string; scope: string[] }>

      as property, redirect_uri and scope are available, and must be the same as when you register your app

    Returns Promise<string>

getAccount

getAccountFavourites

  • getAccountFavourites(id: string, options?: { limit?: number; max_id?: string; since_id?: string }): Promise<Response<Entity.Status[]>>
  • GET /api/v1/pleroma/accounts/:id/favourites

    Parameters

    • id: string
    • Optional options: { limit?: number; max_id?: string; since_id?: string }
      • Optional limit?: number
      • Optional max_id?: string
      • Optional since_id?: string

    Returns Promise<Response<Entity.Status[]>>

    Array of statuses.

getAccountFollowers

  • getAccountFollowers(id: string, options?: { limit?: number; max_id?: string; since_id?: string }): Promise<Response<Entity.Account[]>>
  • GET /api/v1/accounts/:id/followers

    Parameters

    • id: string
    • Optional options: { limit?: number; max_id?: string; since_id?: string }
      • Optional limit?: number
      • Optional max_id?: string
      • Optional since_id?: string

    Returns Promise<Response<Entity.Account[]>>

    The array of accounts.

getAccountFollowing

  • getAccountFollowing(id: string, options?: { limit?: number; max_id?: string; since_id?: string }): Promise<Response<Entity.Account[]>>
  • GET /api/v1/accounts/:id/following

    Parameters

    • id: string
    • Optional options: { limit?: number; max_id?: string; since_id?: string }
      • Optional limit?: number
      • Optional max_id?: string
      • Optional since_id?: string

    Returns Promise<Response<Entity.Account[]>>

    The array of accounts.

getAccountLists

getAccountStatuses

  • getAccountStatuses(id: string, options?: { exclude_reblogs?: boolean; exclude_replies?: boolean; limit?: number; max_id?: string; only_media?: boolean; pinned?: boolean; since_id?: string }): Promise<Response<Entity.Status[]>>
  • GET /api/v1/accounts/:id/statuses

    Parameters

    • id: string
    • Optional options: { exclude_reblogs?: boolean; exclude_replies?: boolean; limit?: number; max_id?: string; only_media?: boolean; pinned?: boolean; since_id?: string }
      • Optional exclude_reblogs?: boolean
      • Optional exclude_replies?: boolean
      • Optional limit?: number
      • Optional max_id?: string
      • Optional only_media?: boolean
      • Optional pinned?: boolean
      • Optional since_id?: string

    Returns Promise<Response<Entity.Status[]>>

    Account's statuses.

getAccountsInList

  • getAccountsInList(id: string, options?: { limit?: number; max_id?: string; since_id?: string }): Promise<Response<Entity.Account[]>>
  • GET /api/v1/lists/:id/accounts

    Parameters

    • id: string
    • Optional options: { limit?: number; max_id?: string; since_id?: string }
      • Optional limit?: number
      • Optional max_id?: string
      • Optional since_id?: string

    Returns Promise<Response<Entity.Account[]>>

    Array of accounts.

getBlocks

  • getBlocks(options?: { limit?: number; max_id?: string; min_id?: string }): Promise<Response<Entity.Account[]>>
  • GET /api/v1/blocks

    Parameters

    • Optional options: { limit?: number; max_id?: string; min_id?: string }
      • Optional limit?: number
      • Optional max_id?: string
      • Optional min_id?: string

    Returns Promise<Response<Entity.Account[]>>

    Array of accounts.

getBookmarks

  • getBookmarks(options?: { limit?: number; max_id?: string; min_id?: string; since_id?: string }): Promise<Response<Entity.Status[]>>
  • GET /api/v1/bookmarks

    Parameters

    • Optional options: { limit?: number; max_id?: string; min_id?: string; since_id?: string }
      • Optional limit?: number
      • Optional max_id?: string
      • Optional min_id?: string
      • Optional since_id?: string

    Returns Promise<Response<Entity.Status[]>>

    Array of statuses.

getConversationTimeline

  • getConversationTimeline(options?: { limit?: number; max_id?: string; min_id?: string; since_id?: string }): Promise<Response<Conversation[]>>
  • GET /api/v1/conversations

    Parameters

    • Optional options: { limit?: number; max_id?: string; min_id?: string; since_id?: string }
      • Optional limit?: number
      • Optional max_id?: string
      • Optional min_id?: string
      • Optional since_id?: string

    Returns Promise<Response<Conversation[]>>

    Array of statuses.

getDomainBlocks

  • getDomainBlocks(options?: { limit?: number; max_id?: string; min_id?: string }): Promise<Response<string[]>>
  • GET /api/v1/domain_blocks

    Parameters

    • Optional options: { limit?: number; max_id?: string; min_id?: string }
      • Optional limit?: number
      • Optional max_id?: string
      • Optional min_id?: string

    Returns Promise<Response<string[]>>

    Array of domain name.

getEmojiReaction

  • GET /api/v1/pleroma/statuses/:status_id/reactions/:emoji

    Parameters

    • id: string

      Target status ID.

    • emoji: string

      Reaction emoji string. This string is url encoded unicode emoji.

    Returns Promise<Response<Reaction>>

getEmojiReactions

getEndorsements

  • getEndorsements(options?: { limit?: number; max_id?: string; since_id?: string }): Promise<Response<Entity.Account[]>>
  • GET /api/v1/endorsements

    Parameters

    • Optional options: { limit?: number; max_id?: string; since_id?: string }
      • Optional limit?: number
      • Optional max_id?: string
      • Optional since_id?: string

    Returns Promise<Response<Entity.Account[]>>

    Array of accounts.

getFavourites

  • getFavourites(options?: { limit?: number; max_id?: string; min_id?: string }): Promise<Response<Entity.Status[]>>
  • GET /api/v1/favourites

    Parameters

    • Optional options: { limit?: number; max_id?: string; min_id?: string }
      • Optional limit?: number
      • Optional max_id?: string
      • Optional min_id?: string

    Returns Promise<Response<Entity.Status[]>>

    Array of statuses.

getFeaturedTags

getFilter

getFilters

getFollowRequests

getHomeTimeline

  • getHomeTimeline(options?: { limit?: number; local?: boolean; max_id?: string; min_id?: string; since_id?: string }): Promise<Response<Entity.Status[]>>
  • GET /api/v1/timelines/home

    Parameters

    • Optional options: { limit?: number; local?: boolean; max_id?: string; min_id?: string; since_id?: string }
      • Optional limit?: number
      • Optional local?: boolean
      • Optional max_id?: string
      • Optional min_id?: string
      • Optional since_id?: string

    Returns Promise<Response<Entity.Status[]>>

    Array of statuses.

getIdentityProof

getInstance

getInstanceActivity

getInstanceCustomEmojis

getInstanceDirectory

  • getInstanceDirectory(options?: { limit?: number; local?: boolean; offset?: number; order?: "active" | "new" }): Promise<Response<Entity.Account[]>>
  • GET /api/v1/directory

    Parameters

    • Optional options: { limit?: number; local?: boolean; offset?: number; order?: "active" | "new" }
      • Optional limit?: number
      • Optional local?: boolean
      • Optional offset?: number
      • Optional order?: "active" | "new"

    Returns Promise<Response<Entity.Account[]>>

    Array of accounts.

getInstancePeers

  • getInstancePeers(): Promise<Response<string[]>>

getInstanceTrends

  • getInstanceTrends(limit?: null | number): Promise<Response<Tag[]>>
  • GET /api/v1/trends

    Parameters

    • Optional limit: null | number

      Maximum number of results to return. Defaults to 10.

    Returns Promise<Response<Tag[]>>

getList

getListTimeline

  • getListTimeline(list_id: string, options?: { limit?: number; max_id?: string; min_id?: string; since_id?: string }): Promise<Response<Entity.Status[]>>
  • GET /api/v1/timelines/list/:list_id

    Parameters

    • list_id: string
    • Optional options: { limit?: number; max_id?: string; min_id?: string; since_id?: string }
      • Optional limit?: number
      • Optional max_id?: string
      • Optional min_id?: string
      • Optional since_id?: string

    Returns Promise<Response<Entity.Status[]>>

    Array of statuses.

getLists

getLocalTimeline

  • getLocalTimeline(options?: { limit?: number; max_id?: string; min_id?: string; only_media?: boolean; since_id?: string }): Promise<Response<Entity.Status[]>>
  • GET /api/v1/timelines/public

    Parameters

    • Optional options: { limit?: number; max_id?: string; min_id?: string; only_media?: boolean; since_id?: string }
      • Optional limit?: number
      • Optional max_id?: string
      • Optional min_id?: string
      • Optional only_media?: boolean
      • Optional since_id?: string

    Returns Promise<Response<Entity.Status[]>>

    Array of statuses.

getMarkers

getMutes

  • getMutes(options?: { limit?: number; max_id?: string; min_id?: string }): Promise<Response<Entity.Account[]>>
  • GET /api/v1/mutes

    Parameters

    • Optional options: { limit?: number; max_id?: string; min_id?: string }
      • Optional limit?: number
      • Optional max_id?: string
      • Optional min_id?: string

    Returns Promise<Response<Entity.Account[]>>

    Array of accounts.

getNotification

getNotifications

  • getNotifications(options?: { account_id?: string; exclude_types?: string[]; limit?: number; max_id?: string; min_id?: string; since_id?: string }): Promise<Response<Notification[]>>
  • GET /api/v1/notifications

    Parameters

    • Optional options: { account_id?: string; exclude_types?: string[]; limit?: number; max_id?: string; min_id?: string; since_id?: string }
      • Optional account_id?: string
      • Optional exclude_types?: string[]
      • Optional limit?: number
      • Optional max_id?: string
      • Optional min_id?: string
      • Optional since_id?: string

    Returns Promise<Response<Notification[]>>

    Array of notifications.

getPoll

getPreferences

getPublicTimeline

  • getPublicTimeline(options?: { limit?: number; max_id?: string; min_id?: string; only_media?: boolean; since_id?: string }): Promise<Response<Entity.Status[]>>
  • GET /api/v1/timelines/public

    Parameters

    • Optional options: { limit?: number; max_id?: string; min_id?: string; only_media?: boolean; since_id?: string }
      • Optional limit?: number
      • Optional max_id?: string
      • Optional min_id?: string
      • Optional only_media?: boolean
      • Optional since_id?: string

    Returns Promise<Response<Entity.Status[]>>

    Array of statuses.

getPushSubscription

getRelationship

getRelationships

getScheduledStatus

getScheduledStatuses

  • getScheduledStatuses(options?: { limit?: null | number; max_id?: null | string; min_id?: null | string; since_id?: null | string }): Promise<Response<ScheduledStatus[]>>
  • GET /api/v1/scheduled_statuses

    Parameters

    • Optional options: { limit?: null | number; max_id?: null | string; min_id?: null | string; since_id?: null | string }
      • Optional limit?: null | number
      • Optional max_id?: null | string
      • Optional min_id?: null | string
      • Optional since_id?: null | string

    Returns Promise<Response<ScheduledStatus[]>>

    Array of scheduled statuses.

getStatus

getStatusContext

  • getStatusContext(id: string, options?: { limit?: number; max_id?: string; since_id?: string }): Promise<Response<Context>>
  • GET /api/v1/statuses/:id/context

    Get parent and child statuses.

    Parameters

    • id: string
    • Optional options: { limit?: number; max_id?: string; since_id?: string }
      • Optional limit?: number
      • Optional max_id?: string
      • Optional since_id?: string

    Returns Promise<Response<Context>>

    Context

getStatusFavouritedBy

getStatusRebloggedBy

getSuggestedTags

getSuggestions

getTagTimeline

  • getTagTimeline(hashtag: string, options?: { limit?: number; local?: boolean; max_id?: string; min_id?: string; only_media?: boolean; since_id?: string }): Promise<Response<Entity.Status[]>>
  • GET /api/v1/timelines/tag/:hashtag

    Parameters

    • hashtag: string
    • Optional options: { limit?: number; local?: boolean; max_id?: string; min_id?: string; only_media?: boolean; since_id?: string }
      • Optional limit?: number
      • Optional local?: boolean
      • Optional max_id?: string
      • Optional min_id?: string
      • Optional only_media?: boolean
      • Optional since_id?: string

    Returns Promise<Response<Entity.Status[]>>

    Array of statuses.

listSocket

  • listSocket(list_id: string): default

listStream

localSocket

  • localSocket(): default

localStream

muteAccount

muteStatus

pinAccount

pinStatus

postStatus

  • postStatus(status: string, options: { in_reply_to_id?: string; language?: string; media_ids?: string[]; poll?: { expires_in: number; hide_totals?: boolean; multiple?: boolean; options: string[] }; scheduled_at?: string; sensitive?: boolean; spoiler_text?: string; visibility?: "public" | "unlisted" | "private" | "direct" }): Promise<Response<Entity.Status>>
  • POST /api/v1/statuses

    Parameters

    • status: string
    • options: { in_reply_to_id?: string; language?: string; media_ids?: string[]; poll?: { expires_in: number; hide_totals?: boolean; multiple?: boolean; options: string[] }; scheduled_at?: string; sensitive?: boolean; spoiler_text?: string; visibility?: "public" | "unlisted" | "private" | "direct" }
      • Optional in_reply_to_id?: string
      • Optional language?: string
      • Optional media_ids?: string[]
      • Optional poll?: { expires_in: number; hide_totals?: boolean; multiple?: boolean; options: string[] }
        • expires_in: number
        • Optional hide_totals?: boolean
        • Optional multiple?: boolean
        • options: string[]
      • Optional scheduled_at?: string
      • Optional sensitive?: boolean
      • Optional spoiler_text?: string
      • Optional visibility?: "public" | "unlisted" | "private" | "direct"

    Returns Promise<Response<Entity.Status>>

    Status

publicSocket

  • publicSocket(): default

publicStream

readConversation

readNotifications

reblogStatus

refreshToken

  • refreshToken(client_id: string, client_secret: string, refresh_token: string): Promise<TokenData>
  • POST /oauth/token

    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>

registerAccount

  • registerAccount(username: string, email: string, password: string, agreement: boolean, locale: string, reason?: null | string): Promise<Response<Token>>
  • POST /api/v1/accounts

    Parameters

    • username: string
    • email: string
    • password: string
    • agreement: boolean
    • locale: string
    • Optional reason: null | string

    Returns Promise<Response<Token>>

    An account token.

registerApp

  • registerApp(client_name: string, options: Partial<{ redirect_uris: string; scopes: string[]; website: string }>): Promise<AppData>
  • First, call createApp to get client_id and client_secret. Next, call generateAuthUrl to get authorization url.

    Parameters

    • client_name: string
    • options: Partial<{ redirect_uris: string; scopes: string[]; website: string }>

    Returns Promise<AppData>

rejectFollowRequest

report

  • report(account_id: string, comment: string, options?: { forward?: boolean; status_ids?: string[] }): Promise<Response<Report>>
  • POST /api/v1/reports

    Parameters

    • account_id: string
    • comment: string
    • Optional options: { forward?: boolean; status_ids?: string[] }
      • Optional forward?: boolean
      • Optional status_ids?: string[]

    Returns Promise<Response<Report>>

    Report

revokeToken

  • revokeToken(client_id: string, client_secret: string, token: string): Promise<Response<{}>>
  • POST /oauth/revoke

    Revoke an OAuth token.

    Parameters

    • client_id: string
    • client_secret: string
    • token: string

    Returns Promise<Response<{}>>

saveMarkers

  • saveMarkers(options?: { home?: { last_read_id: string }; notifications?: { last_read_id: string } }): Promise<Response<Marker>>
  • POST /api/v1/markers

    Parameters

    • Optional options: { home?: { last_read_id: string }; notifications?: { last_read_id: string } }
      • Optional home?: { last_read_id: string }
        • last_read_id: string
      • Optional notifications?: { last_read_id: string }
        • last_read_id: string

    Returns Promise<Response<Marker>>

    Marker.

scheduleStatus

search

  • search(q: string, type: "accounts" | "hashtags" | "statuses", options?: { account_id?: string; exclude_unreviewed?: boolean; following?: boolean; limit?: number; max_id?: string; min_id?: string; offset?: number; resolve?: boolean }): Promise<Response<Results>>
  • GET /api/v2/search

    Parameters

    • q: string
    • type: "accounts" | "hashtags" | "statuses"
    • Optional options: { account_id?: string; exclude_unreviewed?: boolean; following?: boolean; limit?: number; max_id?: string; min_id?: string; offset?: number; resolve?: boolean }
      • Optional account_id?: string
      • Optional exclude_unreviewed?: boolean
      • Optional following?: boolean
      • Optional limit?: number
      • Optional max_id?: string
      • Optional min_id?: string
      • Optional offset?: number
      • Optional resolve?: boolean

    Returns Promise<Response<Results>>

    Results.

searchAccount

  • searchAccount(q: string, options?: { following?: boolean; limit?: number; max_id?: string; resolve?: boolean; since_id?: string }): Promise<Response<Entity.Account[]>>
  • GET /api/v1/accounts/search

    Parameters

    • q: string
    • Optional options: { following?: boolean; limit?: number; max_id?: string; resolve?: boolean; since_id?: string }
      • Optional following?: boolean
      • Optional limit?: number
      • Optional max_id?: string
      • Optional resolve?: boolean
      • Optional since_id?: string

    Returns Promise<Response<Entity.Account[]>>

    The array of accounts.

subscribeAccount

subscribePushNotification

  • subscribePushNotification(subscription: { endpoint: string; keys: { auth: string; p256dh: string } }, data?: null | { alerts: { favourite?: boolean; follow?: boolean; mention?: boolean; poll?: boolean; reblog?: boolean } }): Promise<Response<PushSubscription>>
  • POST /api/v1/push/subscription

    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.

tagSocket

  • tagSocket(tag: string): default

tagStream

unblockAccount

unblockDomain

  • unblockDomain(domain: string): Promise<Response<{}>>

unbookmarkStatus

unfavouriteStatus

unfollowAccount

unmuteAccount

unmuteStatus

unpinAccount

unpinStatus

unreblogStatus

unsubscribeAccount

updateCredentials

  • updateCredentials(options?: { avatar?: string; bot?: boolean; discoverable?: boolean; display_name?: string; fields_attributes?: { name: string; value: string }[]; header?: string; locked?: boolean; note?: string; source?: { language?: string; privacy?: string; sensitive?: boolean } }): Promise<Response<Entity.Account>>
  • PATCH /api/v1/accounts/update_credentials

    Parameters

    • Optional options: { avatar?: string; bot?: boolean; discoverable?: boolean; display_name?: string; fields_attributes?: { name: string; value: string }[]; header?: string; locked?: boolean; note?: string; source?: { language?: string; privacy?: string; sensitive?: boolean } }
      • Optional avatar?: string
      • Optional bot?: boolean
      • Optional discoverable?: boolean
      • Optional display_name?: string
      • Optional fields_attributes?: { name: string; value: string }[]
      • Optional header?: string
      • Optional locked?: boolean
      • Optional note?: string
      • Optional source?: { language?: string; privacy?: string; sensitive?: boolean }
        • Optional language?: string
        • Optional privacy?: string
        • Optional sensitive?: boolean

    Returns Promise<Response<Entity.Account>>

    An account.

updateFilter

  • updateFilter(id: string, phrase: string, context: string[], options?: { expires_in?: string; irreversible?: boolean; whole_word?: boolean }): Promise<Response<Filter>>
  • PUT /api/v1/filters/:id

    Parameters

    • id: string
    • phrase: string
    • context: string[]
    • Optional options: { expires_in?: string; irreversible?: boolean; whole_word?: boolean }
      • Optional expires_in?: string
      • Optional irreversible?: boolean
      • Optional whole_word?: boolean

    Returns Promise<Response<Filter>>

    Filter

updateList

  • updateList(id: string, title: string): Promise<Response<List>>

updateMedia

  • updateMedia(id: string, options?: { description?: string; file?: any; focus?: string }): Promise<Response<Attachment>>
  • PUT /api/v1/media/:id

    Parameters

    • id: string
    • Optional options: { description?: string; file?: any; focus?: string }
      • Optional description?: string
      • Optional file?: any
      • Optional focus?: string

    Returns Promise<Response<Attachment>>

    Attachment

updatePushSubscription

  • updatePushSubscription(data?: null | { alerts: { favourite?: boolean; follow?: boolean; mention?: boolean; poll?: boolean; reblog?: boolean } }): Promise<Response<PushSubscription>>
  • PUT /api/v1/push/subscription

    Parameters

    • Optional data: null | { alerts: { favourite?: boolean; follow?: boolean; mention?: boolean; poll?: boolean; reblog?: boolean } }

    Returns Promise<Response<PushSubscription>>

    PushSubscription.

uploadMedia

  • uploadMedia(file: any, options?: { description?: string; focus?: string }): Promise<Response<Attachment>>
  • POST /api/v1/media

    Parameters

    • file: any
    • Optional options: { description?: string; focus?: string }
      • Optional description?: string
      • Optional focus?: string

    Returns Promise<Response<Attachment>>

    Attachment

userSocket

  • userSocket(): default

userStream

verifyAccountCredentials

verifyAppCredentials

votePoll

  • votePoll(id: string, choices: number[]): Promise<Response<Poll>>

Generated using TypeDoc