Interface FilterRepository

interface FilterRepository {
    keywords: {
        $select(id): {
            fetch(meta?): Paginator<FilterKeyword, undefined>;
            remove(meta?): Promise<void>;
            update(params, meta?): Promise<FilterKeyword>;
        };
    };
    statuses: {
        $select(id): {
            fetch(): Promise<FilterStatus>;
            remove(): Promise<FilterStatus>;
        };
    };
    $select(id): {
        keywords: {
            create(params, meta?): Promise<FilterKeyword>;
            list(meta?): Paginator<FilterKeyword[], undefined>;
        };
        statuses: {
            create(params, meta?): Promise<FilterStatus>;
            list(meta?): Paginator<FilterStatus[], undefined>;
        };
        fetch(meta?): Promise<mastodon.v2.Filter>;
        remove(meta?): Promise<void>;
        update(params?, meta?): Promise<mastodon.v2.Filter>;
    };
    create(params?, meta?): Promise<mastodon.v2.Filter>;
    list(meta?): Paginator<mastodon.v2.Filter[], undefined>;
}

Index

Properties

keywords statuses

Methods

$select create list

Properties

keywords

keywords: {
    $select(id): {
        fetch(meta?): Paginator<FilterKeyword, undefined>;
        remove(meta?): Promise<void>;
        update(params, meta?): Promise<FilterKeyword>;
    };
}

Type declaration

$select:function
- $select(id): {
      fetch(meta?): Paginator<FilterKeyword, undefined>;
      remove(meta?): Promise<void>;
      update(params, meta?): Promise<FilterKeyword>;
  }
- Parameters
  - id: string
  Returns {
      fetch(meta?): Paginator<FilterKeyword, undefined>;
      remove(meta?): Promise<void>;
      update(params, meta?): Promise<FilterKeyword>;
  }
  - fetch:function
    - fetch(meta?): Paginator<FilterKeyword, undefined>
    - Get one filter keyword by the given id.
      Parameters
      Optional meta: HttpMetaParams<"none">
      Returns Paginator<FilterKeyword, undefined>
      FilterKeyword
      
      See
      https://docs.joinmastodon.org/methods/filters/#keywords-get-one
      Defined in src/mastodon/rest/v2/filter-repository.ts:157
  - remove:function
    - remove(meta?): Promise<void>
    - Deletes the given filter keyword.
      Parameters
      Optional meta: HttpMetaParams<"none">
      Returns Promise<void>
      empty object
      
      See
      https://docs.joinmastodon.org/methods/filters/#keywords-delete
      Defined in src/mastodon/rest/v2/filter-repository.ts:175
  - update:function
    - update(params, meta?): Promise<FilterKeyword>
    - Update the given filter keyword.
      Parameters
      params: CreateFilterKeywordParams
      Parameters
      
      Optional meta: HttpMetaParams<"json">
      Returns Promise<FilterKeyword>
      FilterKeywords
      
      See
      https://docs.joinmastodon.org/methods/filters/#keywords-update
      Defined in src/mastodon/rest/v2/filter-repository.ts:165
  - Defined in src/mastodon/rest/v2/filter-repository.ts:151

statuses

statuses: {
    $select(id): {
        fetch(): Promise<FilterStatus>;
        remove(): Promise<FilterStatus>;
    };
}

Type declaration

$select:function
- $select(id): {
  fetch(): Promise<FilterStatus>;
  remove(): Promise<FilterStatus>;
  }
- Parameters
  - id: string
  Returns {
  fetch(): Promise<FilterStatus>;
  remove(): Promise<FilterStatus>;
  }
  - fetch:function
    - fetch(): Promise<FilterStatus>
    - Obtain a single status filter.
      
      Returns Promise<FilterStatus>
      FilterStatus
      
      See
      https://docs.joinmastodon.org/methods/filters/#statuses-get-one
      Defined in src/mastodon/rest/v2/filter-repository.ts:186
  - remove:function
    - remove(): Promise<FilterStatus>
    - Returns Promise<FilterStatus>
      FilterStatus
      
      See
      https://docs.joinmastodon.org/methods/filters/#statuses-get-one
      Defined in src/mastodon/rest/v2/filter-repository.ts:192
  - Defined in src/mastodon/rest/v2/filter-repository.ts:180

Methods

$select

$select(id): {
    keywords: {
        create(params, meta?): Promise<FilterKeyword>;
        list(meta?): Paginator<FilterKeyword[], undefined>;
    };
    statuses: {
        create(params, meta?): Promise<FilterStatus>;
        list(meta?): Paginator<FilterStatus[], undefined>;
    };
    fetch(meta?): Promise<mastodon.v2.Filter>;
    remove(meta?): Promise<void>;
    update(params?, meta?): Promise<mastodon.v2.Filter>;
}
Parameters
- id: string
Returns {
    keywords: {
        create(params, meta?): Promise<FilterKeyword>;
        list(meta?): Paginator<FilterKeyword[], undefined>;
    };
    statuses: {
        create(params, meta?): Promise<FilterStatus>;
        list(meta?): Paginator<FilterStatus[], undefined>;
    };
    fetch(meta?): Promise<mastodon.v2.Filter>;
    remove(meta?): Promise<void>;
    update(params?, meta?): Promise<mastodon.v2.Filter>;
}
- keywords: {
  create(params, meta?): Promise<FilterKeyword>;
  list(meta?): Paginator<FilterKeyword[], undefined>;
  }
  - create:function
    - create(params, meta?): Promise<FilterKeyword>
    - Add the given keyword to the specified filter group
      Parameters
      params: CreateFilterKeywordParams
      Parameters
      
      Optional meta: HttpMetaParams<"json">
      Returns Promise<FilterKeyword>
      FilterKeywords
      
      See
      https://docs.joinmastodon.org/methods/filters/#keywords-create
      Defined in src/mastodon/rest/v2/filter-repository.ts:116
  - list:function
    - list(meta?): Paginator<FilterKeyword[], undefined>
    - List all keywords attached to the current filter group.
      Parameters
      Optional meta: HttpMetaParams<"none">
      Returns Paginator<FilterKeyword[], undefined>
      Array of FilterKeyword
      
      See
      https://docs.joinmastodon.org/methods/filters/#keywords-get
      Defined in src/mastodon/rest/v2/filter-repository.ts:126
- statuses: {
  create(params, meta?): Promise<FilterStatus>;
  list(meta?): Paginator<FilterStatus[], undefined>;
  }
  - create:function
    - create(params, meta?): Promise<FilterStatus>
    - Add a status filter to the current filter group.
      Parameters
      params: CreateFilterStatusParams
      Optional meta: HttpMetaParams<"json">
      Returns Promise<FilterStatus>
      FilterStatus
      
      See
      https://docs.joinmastodon.org/methods/filters/#statuses-add
      Defined in src/mastodon/rest/v2/filter-repository.ts:143
  - list:function
    - list(meta?): Paginator<FilterStatus[], undefined>
    - Obtain a list of all status filters within this filter group.
      Parameters
      Optional meta: HttpMetaParams<"none">
      Returns Paginator<FilterStatus[], undefined>
      Array of FilterStatus
      
      See
      https://docs.joinmastodon.org/methods/filters/#statuses-get
      Defined in src/mastodon/rest/v2/filter-repository.ts:135
- fetch:function
  - fetch(meta?): Promise<mastodon.v2.Filter>
  - Obtain a single filter group owned by the current user.
    Parameters
    - Optional meta: HttpMetaParams<"none">
    Returns Promise<mastodon.v2.Filter>
    Filter
    
    See
    https://docs.joinmastodon.org/methods/filters/#get-one
    - Defined in src/mastodon/rest/v2/filter-repository.ts:88
- remove:function
  - remove(meta?): Promise<void>
  - Delete a filter group with the given id.
    Parameters
    - Optional meta: HttpMetaParams<"none">
    Returns Promise<void>
    N/A
    
    See
    https://docs.joinmastodon.org/methods/filters/#delete
    - Defined in src/mastodon/rest/v2/filter-repository.ts:106
- update:function
  - update(params?, meta?): Promise<mastodon.v2.Filter>
  - Update a filter group with the given parameters.
    Parameters
    - Optional params: mastodon.rest.v2.UpdateFilterParams
      Parameters
    - Optional meta: HttpMetaParams<"json">
    Returns Promise<mastodon.v2.Filter>
    Filter
    
    See
    https://docs.joinmastodon.org/methods/filters/#update
    - Defined in src/mastodon/rest/v2/filter-repository.ts:96
- Defined in src/mastodon/rest/v2/filter-repository.ts:82

create

create(params?, meta?): Promise<mastodon.v2.Filter>
Create a filter group with the given parameters.
Parameters
- Optional params: mastodon.rest.v2.CreateFilterParams
  Parameters
- Optional meta: HttpMetaParams<"json">
Returns Promise<mastodon.v2.Filter>
Filter

See
https://docs.joinmastodon.org/methods/filters/#create
- Defined in src/mastodon/rest/v2/filter-repository.ts:77

list

list(meta?): Paginator<mastodon.v2.Filter[], undefined>
View all filters
Parameters
- Optional meta: HttpMetaParams<"none">
Returns Paginator<mastodon.v2.Filter[], undefined>
Array of Filter

See
https://docs.joinmastodon.org/methods/filters/#get
- Defined in src/mastodon/rest/v2/filter-repository.ts:69

Interface FilterRepository

Index

Properties

Methods

Properties

keywords

Type declaration

$select:function

Parameters

Returns { fetch(meta?): Paginator<FilterKeyword, undefined>; remove(meta?): Promise<void>; update(params, meta?): Promise<FilterKeyword>; }

fetch:function

Parameters

Returns Paginator<FilterKeyword, undefined>

See

remove:function

Parameters

Returns Promise<void>

See

update:function

Parameters

Returns Promise<FilterKeyword>

See

statuses

Type declaration

$select:function

Parameters

Returns { fetch(): Promise<FilterStatus>; remove(): Promise<FilterStatus>; }

fetch:function

Returns Promise<FilterStatus>

See

remove:function

Returns Promise<FilterStatus>

See

Methods

$select

Parameters

keywords: { create(params, meta?): Promise<FilterKeyword>; list(meta?): Paginator<FilterKeyword[], undefined>; }

create:function

Parameters

Returns Promise<FilterKeyword>

See

list:function

Parameters

Returns Paginator<FilterKeyword[], undefined>

See

statuses: { create(params, meta?): Promise<FilterStatus>; list(meta?): Paginator<FilterStatus[], undefined>; }

create:function

Parameters

Returns Promise<FilterStatus>

See

list:function

Parameters

Returns Paginator<FilterStatus[], undefined>

See

fetch:function

Parameters

Returns Promise<mastodon.v2.Filter>

See

remove:function

Parameters

Returns Promise<void>

See

update:function

Parameters

Returns Promise<mastodon.v2.Filter>

See

create

Parameters

Returns Promise<mastodon.v2.Filter>

See

list

Parameters

Returns Paginator<mastodon.v2.Filter[], undefined>

See

Settings

Member Visibility

Theme

On This Page

Returns {
fetch(meta?): Paginator<FilterKeyword, undefined>;
remove(meta?): Promise<void>;
update(params, meta?): Promise<FilterKeyword>;
}

Returns {
fetch(): Promise<FilterStatus>;
remove(): Promise<FilterStatus>;
}

keywords: {
create(params, meta?): Promise<FilterKeyword>;
list(meta?): Paginator<FilterKeyword[], undefined>;
}

statuses: {
create(params, meta?): Promise<FilterStatus>;
list(meta?): Paginator<FilterStatus[], undefined>;
}