Interface Filter

Represents a user-defined filter for determining which statuses should not be shown to the user.

interface Filter {
    context: mastodon.v2.FilterContext[];
    expiresAt?: null | string;
    filterAction: FilterAction;
    id: string;
    keywords: FilterKeyword[];
    statuses: FilterStatus[];
    title: string;
}

Properties

The contexts in which the filter should be applied.

expiresAt?: null | string

When the filter should no longer be applied

filterAction: FilterAction

The action to be taken when a status matches this filter.

warn = show a warning that identifies the matching filter by title, and allow the user to expand the filtered status. This is the default (and unknown values should be treated as equivalent to warn).

hide = do not show this status if it is received

id: string

The ID of the filter in the database.

keywords: FilterKeyword[]

The keywords grouped under this filter.

statuses: FilterStatus[]

The statuses grouped under this filter.

title: string

A title given by the user to name the filter.