Interface CreateFilterParams

interface CreateFilterParams {
    context: null | readonly mastodon.v2.FilterContext[];
    expiresIn?: null | number;
    filterAction?: null | FilterAction;
    keywordsAttributes?: {
        keyword?: null | string;
        wholeWord?: null | boolean;
    }[];
    title: string;
}

Properties

context expiresIn? filterAction? keywordsAttributes? title

Properties

Readonly context

context: null | readonly mastodon.v2.FilterContext[]

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

Optional Readonly expiresIn

expiresIn?: null | number

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

Optional Readonly filterAction

filterAction?: null | FilterAction

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

Optional Readonly keywordsAttributes

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

Type declaration

  • Optional Readonly keyword?: null | string

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

  • Optional Readonly wholeWord?: null | boolean

    Boolean. Whether the keyword should consider word boundaries.

Readonly title

title: string

String. The name of the filter group.

Settings

Member Visibility

Theme

On This Page

contextexpiresInfilterActionkeywordsAttributestitle