masto
    Preparing search index...

    Interface CreateFilterParams

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

    Properties

    context expiresIn? filterAction? keywordsAttributes? title

    Properties

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

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

    expiresIn?: number | null

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

    filterAction?: (keyof FilterActionRegistry) | null

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

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

    Type Declaration

    • Optional Readonlykeyword?: string | null

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

    • Optional ReadonlywholeWord?: boolean | null

      Boolean. Whether the keyword should consider word boundaries.

    title: string

    String. The name of the filter group.

    Settings

    Member Visibility

    On This Page

    Properties