Interface ListRepository

Returns {
    accounts: {
        create(
            params: AddListAccountsParams,
            meta?: HttpMetaParams<"json">,
        ): Promise<void>;
        list(
            params?: DefaultPaginationParams,
            meta?: HttpMetaParams<"none">,
        ): Paginator<mastodon.v1.Account[], DefaultPaginationParams>;
        remove(
            params: AddListAccountsParams,
            meta?: HttpMetaParams<"json">,
        ): Promise<void>;
    };
    fetch(meta?: HttpMetaParams<"none">): Promise<List>;
    remove(meta?: HttpMetaParams<"none">): Promise<void>;
    update(
        params: CreateListParams,
        meta?: HttpMetaParams<"json">,
    ): Promise<List>;
}

• accounts: {
      create(
          params: AddListAccountsParams,
          meta?: HttpMetaParams<"json">,
      ): Promise<void>;
      list(
          params?: DefaultPaginationParams,
          meta?: HttpMetaParams<"none">,
      ): Paginator<mastodon.v1.Account[], DefaultPaginationParams>;
      remove(
          params: AddListAccountsParams,
          meta?: HttpMetaParams<"json">,
      ): Promise<void>;
  }

  • create:function

    • create(
          params: AddListAccountsParams,
          meta?: HttpMetaParams<"json">,
      ): Promise<void>

      Add accounts to the given list. Note that the user must be following these accounts.

      Parameters

      • params: AddListAccountsParams

        Parameters
      • Optionalmeta: HttpMetaParams<"json">

      Returns Promise<void>

      N/A

      See

      https://docs.joinmastodon.org/methods/timelines/lists#accounts-add

  • list:function

    • list(
          params?: DefaultPaginationParams,
          meta?: HttpMetaParams<"none">,
      ): Paginator<mastodon.v1.Account[], DefaultPaginationParams>

      View accounts in list

      Parameters

      • Optionalparams: DefaultPaginationParams

        Parameters
      • Optionalmeta: HttpMetaParams<"none">

      Returns Paginator<mastodon.v1.Account[], DefaultPaginationParams>

      Array of Account

      See

      https://docs.joinmastodon.org/methods/timelines/lists#accounts

  • remove:function

    • remove(
          params: AddListAccountsParams,
          meta?: HttpMetaParams<"json">,
      ): Promise<void>

      Remove accounts from the given list.

      Parameters

      • params: AddListAccountsParams

        Parameters
      • Optionalmeta: HttpMetaParams<"json">

      Returns Promise<void>

      N/A

      See

      https://docs.joinmastodon.org/methods/timelines/lists#accounts-remove

• fetch:function

  • fetch(meta?: HttpMetaParams<"none">): Promise<List>

    Fetch the list with the given ID. Used for verifying the title of a list.

    Parameters

    • Optionalmeta: HttpMetaParams<"none">

    Returns Promise<List>

    List

    See

    https://docs.joinmastodon.org/methods/timelines/lists/

• remove:function

  • remove(meta?: HttpMetaParams<"none">): Promise<void>

    Delete a list

    Parameters

    • Optionalmeta: HttpMetaParams<"none">

    Returns Promise<void>

    N/A

    See

    https://docs.joinmastodon.org/methods/timelines/lists/

• update:function

  • update(params: CreateListParams, meta?: HttpMetaParams<"json">): Promise<List>

    Change the title of a list.

    Parameters

    • params: CreateListParams

      Parameters
    • Optionalmeta: HttpMetaParams<"json">

    Returns Promise<List>

    List

    See

    https://docs.joinmastodon.org/methods/timelines/lists/

Returns Promise<List>

List

Returns Paginator<List[]>

Array of List