Interface FilterRepository

keywords

statuses

$select

• $select(
      id: string,
  ): {
      keywords: {
          create(
              params: CreateFilterKeywordParams,
              meta?: HttpMetaParams<"json">,
          ): Promise<FilterKeyword>;
          list(meta?: HttpMetaParams<"none">): Paginator<FilterKeyword[]>;
      };
      statuses: {
          create(
              params: CreateFilterStatusParams,
              meta?: HttpMetaParams<"json">,
          ): Promise<FilterStatus>;
          list(meta?: HttpMetaParams<"none">): Paginator<FilterStatus[]>;
      };
      fetch(meta?: HttpMetaParams<"none">): Promise<mastodon.v2.Filter>;
      remove(meta?: HttpMetaParams<"none">): Promise<void>;
      update(
          params?: mastodon.rest.v2.UpdateFilterParams,
          meta?: HttpMetaParams<"json">,
      ): Promise<mastodon.v2.Filter>;
  }

  Parameters

  • id: string

  Returns {
      keywords: {
          create(
              params: CreateFilterKeywordParams,
              meta?: HttpMetaParams<"json">,
          ): Promise<FilterKeyword>;
          list(meta?: HttpMetaParams<"none">): Paginator<FilterKeyword[]>;
      };
      statuses: {
          create(
              params: CreateFilterStatusParams,
              meta?: HttpMetaParams<"json">,
          ): Promise<FilterStatus>;
          list(meta?: HttpMetaParams<"none">): Paginator<FilterStatus[]>;
      };
      fetch(meta?: HttpMetaParams<"none">): Promise<mastodon.v2.Filter>;
      remove(meta?: HttpMetaParams<"none">): Promise<void>;
      update(
          params?: mastodon.rest.v2.UpdateFilterParams,
          meta?: HttpMetaParams<"json">,
      ): Promise<mastodon.v2.Filter>;
  }

  • keywords: {
        create(
            params: CreateFilterKeywordParams,
            meta?: HttpMetaParams<"json">,
        ): Promise<FilterKeyword>;
        list(meta?: HttpMetaParams<"none">): Paginator<FilterKeyword[]>;
    }

    • create:function

      • create(
            params: CreateFilterKeywordParams,
            meta?: HttpMetaParams<"json">,
        ): Promise<FilterKeyword>

        Add the given keyword to the specified filter group

        Parameters

        • params: CreateFilterKeywordParams

          Parameters
        • Optionalmeta: HttpMetaParams<"json">

        Returns Promise<FilterKeyword>

        FilterKeywords

        See

        https://docs.joinmastodon.org/methods/filters/#keywords-create

    • list:function

      • list(meta?: HttpMetaParams<"none">): Paginator<FilterKeyword[]>

        List all keywords attached to the current filter group.

        Parameters

        • Optionalmeta: HttpMetaParams<"none">

        Returns Paginator<FilterKeyword[]>

        Array of FilterKeyword

        See

        https://docs.joinmastodon.org/methods/filters/#keywords-get

  • statuses: {
        create(
            params: CreateFilterStatusParams,
            meta?: HttpMetaParams<"json">,
        ): Promise<FilterStatus>;
        list(meta?: HttpMetaParams<"none">): Paginator<FilterStatus[]>;
    }

    • create:function

      • create(
            params: CreateFilterStatusParams,
            meta?: HttpMetaParams<"json">,
        ): Promise<FilterStatus>

        Add a status filter to the current filter group.

        Parameters

        • params: CreateFilterStatusParams
        • Optionalmeta: HttpMetaParams<"json">

        Returns Promise<FilterStatus>

        FilterStatus

        See

        https://docs.joinmastodon.org/methods/filters/#statuses-add

    • list:function

      • list(meta?: HttpMetaParams<"none">): Paginator<FilterStatus[]>

        Obtain a list of all status filters within this filter group.

        Parameters

        • Optionalmeta: HttpMetaParams<"none">

        Returns Paginator<FilterStatus[]>

        Array of FilterStatus

        See

        https://docs.joinmastodon.org/methods/filters/#statuses-get

  • fetch:function

    • fetch(meta?: HttpMetaParams<"none">): Promise<mastodon.v2.Filter>

      Obtain a single filter group owned by the current user.

      Parameters

      • Optionalmeta: HttpMetaParams<"none">

      Returns Promise<mastodon.v2.Filter>

      Filter

      See

      https://docs.joinmastodon.org/methods/filters/#get-one

  • remove:function

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

      Delete a filter group with the given id.

      Parameters

      • Optionalmeta: HttpMetaParams<"none">

      Returns Promise<void>

      N/A

      See

      https://docs.joinmastodon.org/methods/filters/#delete

  • update:function

    • update(
          params?: mastodon.rest.v2.UpdateFilterParams,
          meta?: HttpMetaParams<"json">,
      ): Promise<mastodon.v2.Filter>

      Update a filter group with the given parameters.

      Parameters

      • Optionalparams: mastodon.rest.v2.UpdateFilterParams

        Parameters
      • Optionalmeta: HttpMetaParams<"json">

      Returns Promise<mastodon.v2.Filter>

      Filter

      See

      https://docs.joinmastodon.org/methods/filters/#update

create

• create(
      params?: mastodon.rest.v2.CreateFilterParams,
      meta?: HttpMetaParams<"json">,
  ): Promise<mastodon.v2.Filter>

  Create a filter group with the given parameters.

  Parameters

  • Optionalparams: mastodon.rest.v2.CreateFilterParams

    Parameters
  • Optionalmeta: HttpMetaParams<"json">

  Returns Promise<mastodon.v2.Filter>

  Filter

  See

  https://docs.joinmastodon.org/methods/filters/#create

list

• list(meta?: HttpMetaParams<"none">): Paginator<mastodon.v2.Filter[]>

  View all filters

  Parameters

  • Optionalmeta: HttpMetaParams<"none">

  Returns Paginator<mastodon.v2.Filter[]>

  Array of Filter

  See

  https://docs.joinmastodon.org/methods/filters/#get