Interface CreateFilterParams

interface CreateFilterParams {
    context: null | readonly (keyof mastodon.v2.FilterContextRegistry)[];
    expiresIn?: null | number;
    filterAction?: null | (keyof FilterActionRegistry);
    keywordsAttributes?: {
        keyword?: null | string;
        wholeWord?: null | boolean;
    }[];
    title: string;
}

Properties

context expiresIn? filterAction? keywordsAttributes? title

Properties

Readonlycontext

context: null | readonly (keyof mastodon.v2.FilterContextRegistry)[]

Array of String. Where the filter should be applied. Specify at least one of home, notifications, public, thread, account.

Optional ReadonlyexpiresIn

expiresIn?: null | number

Integer. How many seconds from now should the filter expire?

Optional ReadonlyfilterAction

filterAction?: null | (keyof FilterActionRegistry)

String. The policy to be applied when the filter is matched. Specify warn or hide.

Optional ReadonlykeywordsAttributes

keywordsAttributes?: { keyword?: null | string; wholeWord?: null | boolean }[]

Type declaration

  • Optional Readonlykeyword?: null | string

    String. A keyword to be added to the newly-created filter group.

  • Optional ReadonlywholeWord?: null | boolean

    Boolean. Whether the keyword should consider word boundaries.

Readonlytitle

title: string

String. The name of the filter group.

Settings

Member Visibility

On This Page

Properties