Interface FiltersResource

interface FiltersResource {
    create: Method<
        mastodon.v2.Filter,
        mastodon.rest.v2.CreateFilterParams,
        HttpMetaParams<"json">,
    >;
    keywords: FiltersKeywordsResource;
    list: Method<Paginator<mastodon.v2.Filter[], undefined>>;
    statuses: FiltersStatusesResource;
    $select(id: string): mastodon.rest.v2.Filters$SelectResource;
}

Index

Properties

create keywords list statuses

Methods

Properties

create

create: Method<
    mastodon.v2.Filter,
    mastodon.rest.v2.CreateFilterParams,
    HttpMetaParams<"json">,
>

Create a filter group with the given parameters.

Param: params

Parameters

Returns

Filter

See

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

keywords

keywords: FiltersKeywordsResource

list

list: Method<Paginator<mastodon.v2.Filter[], undefined>>

View all filters

Returns

Array of Filter

See

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

statuses

statuses: FiltersStatusesResource

Methods

$select

$select(id: string): mastodon.rest.v2.Filters$SelectResource
Parameters
- id: string
Returns mastodon.rest.v2.Filters$SelectResource
- Defined in src/mastodon/rest/v2/filters.ts:193