Class Misskey

Hierarchy

  • Misskey

Implements

Constructors

Properties

Methods

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

Constructors

  • 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 Misskey

Properties

baseUrl: string
client: Interface
proxyConfig: false | ProxyConfig

Methods

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

  • POST /api/v1/filters

    Returns

    Filter

    Parameters

    • _phrase: string

      Text to be filtered.

    • _context: string[]

      Array of enumerable strings home, notifications, public, thread, account. At least one context must be specified.

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

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

  • POST /api/auth/session/generate

    Parameters

    • clientSecret: string

    Returns Promise<Session>

  • GET /api/v1/pleroma/accounts/:id/favourites

    Returns

    Array of statuses.

    Parameters

    • _id: string

      Target account ID.

    • 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[]>>

  • POST /api/users/notes

    Parameters

    • id: string
    • Optional options: {
          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
      • Optional limit?: number
      • Optional max_id?: string
      • Optional only_media?: boolean
      • Optional pinned?: boolean
      • Optional since_id?: string

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

  • GET /api/v1/bookmarks

    Returns

    Array of statuses.

    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[]>>

  • POST /api/notes/mentions

    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[]>>

  • GET /api/v1/domain_blocks

    Returns

    Array of domain name.

    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[]>>

  • GET /api/v1/endorsements

    Returns

    Array of accounts.

    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[]>>

  • POST /api/notes/timeline

    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[]>>

  • GET /api/v1/directory

    Returns

    Array of accounts.

    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[]>>

  • POST /api/notes/user-list-timeline

    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[]>>

  • POST /api/notes/local-timeline

    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[]>>

  • POST /api/i/notifications

    Parameters

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

    Returns Promise<Response<Notification[]>>

  • POST /api/notes/global-timeline

    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[]>>

  • GET /api/v1/scheduled_statuses

    Returns

    Array of scheduled statuses.

    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<ScheduledStatus[]>>

  • POST /api/notes/children

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

  • POST /api/notes/search-by-tag

    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[]>>

  • POST /api/v1/statuses

    Returns

    Status

    Parameters

    • status: string

      Text content of status.

    • Optional options: {
          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?: "direct" | "private" | "public" | "unlisted";
      }
      • 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 quote_id?: string
      • Optional scheduled_at?: string
      • Optional sensitive?: boolean
      • Optional spoiler_text?: string
      • Optional visibility?: "direct" | "private" | "public" | "unlisted"

    Returns Promise<Response<Entity.Status>>

  • POST /oauth/token

    Refresh OAuth access token. Send refresh token and get new access token.

    Parameters

    • _client_id: string

      will be generated by #createApp or #registerApp

    • _client_secret: string

      will be generated by #createApp or #registerApp

    • _refresh_token: string

      will be get #fetchAccessToken

    Returns Promise<TokenData>

  • POST /api/v1/accounts

    Returns

    An account token.

    Parameters

    • _username: string

      Username for the account.

    • _email: string

      Email for the account.

    • _password: string

      Password for the account.

    • _agreement: boolean

      Whether the user agrees to the local rules, terms, and policies.

    • _locale: string

      The language of the confirmation email that will be sent

    • Optional _reason: null | string

      Text that will be reviewed by moderators if registrations require manual approval.

    Returns Promise<Response<Token>>

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

  • POST /api/users/report-abuse

    Parameters

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

    Returns Promise<Response<Report>>

  • POST /oauth/revoke

    Revoke an OAuth token.

    Parameters

    • _client_id: string

      will be generated by #createApp or #registerApp

    • _client_secret: string

      will be generated by #createApp or #registerApp

    • _token: string

      will be get #fetchAccessToken

    Returns Promise<Response<{}>>

  • POST /api/v1/markers

    Returns

    Marker.

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

  • GET /api/v2/search

    Returns

    Results.

    Parameters

    • q: string

      The search query.

    • type: "accounts" | "hashtags" | "statuses"

      Enum of search target.

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

  • POST /api/users/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[]>>

  • POST /api/v1/push/subscription

    Returns

    PushSubscription.

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

  • POST /api/i/update

    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?: null | {
              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?: null | {
            language?: string;
            privacy?: string;
            sensitive?: boolean;
        }

    Returns Promise<Response<Entity.Account>>

  • PUT /api/v1/filters/:id

    Returns

    Filter

    Parameters

    • _id: string

      The filter ID.

    • _phrase: string

      Text to be filtered.

    • _context: string[]

      Array of enumerable strings home, notifications, public, thread, account. At least one context must be specified.

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

  • POST /api/drive/files/update

    Parameters

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

    Returns Promise<Response<Attachment>>

  • PUT /api/v1/push/subscription

    Returns

    PushSubscription.

    Parameters

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

    Returns Promise<Response<PushSubscription>>

Generated using TypeDoc