Interface FiltersResource

interface FiltersResource {
    $select(id: string): Filter$SelectResource;
    create(
        params?: mastodon.rest.v1.CreateFilterParams,
        meta?: HttpMetaParams<"json">,
    ): Promise<mastodon.v1.Filter>;
    list(meta?: HttpMetaParams<"none">): Paginator<mastodon.v1.Filter[]>;
}

Index

Methods

$select create list

Methods

$select

$select(id: string): Filter$SelectResource
Parameters
- id: string
Returns Filter$SelectResource
- Defined in src/mastodon/rest/v1/filters.ts:51

create

create(
params?: mastodon.rest.v1.CreateFilterParams,
meta?: HttpMetaParams<"json">,
): Promise<mastodon.v1.Filter>
Create a filter
Parameters
- Optionalparams: mastodon.rest.v1.CreateFilterParams
  Parameters
- Optionalmeta: HttpMetaParams<"json">
Returns Promise<mastodon.v1.Filter>
Filter

See
https://docs.joinmastodon.org/methods/accounts/filters/
- Defined in src/mastodon/rest/v1/filters.ts:66

list

list(meta?: HttpMetaParams<"none">): Paginator<mastodon.v1.Filter[]>
View all filters
Parameters
- Optionalmeta: HttpMetaParams<"none">
Returns Paginator<mastodon.v1.Filter[]>
Filter

See
https://docs.joinmastodon.org/methods/accounts/filters/
- Defined in src/mastodon/rest/v1/filters.ts:58