module Mastodon::REST::Filters

Public Instance Methods

create_filter(params = {}) click to toggle source

Create a filter @param params [Hash] @option params :phrase [String] @option params :context [Array<String>] @option params :irreversible [Boolean] @option params :whole_word [Boolean] @option params :expires_in [Integer] @return [Mastodon::Filter]

# File lib/mastodon/rest/filters.rb, line 35
def create_filter(params = {})
  params[:'context[]'] = params.delete(:context) if params.key?(:context)
  perform_request_with_object(:post, '/api/v1/filters', params, Mastodon::Filter)
end
delete_filter(id) click to toggle source

Delete a filter @param id [Integer]

# File lib/mastodon/rest/filters.rb, line 56
def delete_filter(id)
  perform_request(:delete, "/api/v1/filters/#{id}")
end
filter(id) click to toggle source

Retrieve a filter @param id [Integer] @return [Mastodon::Filter]

# File lib/mastodon/rest/filters.rb, line 23
def filter(id)
  perform_request_with_object(:put, "/api/v1/filters/#{id}", {}, Mastodon::Filter)
end
filters(options = {}) click to toggle source

Get a list of filters @param options [Hash] @option options :max_id [Integer] @option options :since_id [Integer] @option options :min_id [Integer] @option options :limit [Integer] @return [Mastodon::Collection<Mastodon::Filter>]

# File lib/mastodon/rest/filters.rb, line 16
def filters(options = {})
  perform_request_with_collection('/api/v1/filters', options, Mastodon::Filter)
end
update_filter(id, params = {}) click to toggle source

Update a filter @param id [Integer] @param params [Hash] @option params :phrase [String] @option params :context [Array<String>] @option params :irreversible [Boolean] @option params :whole_word [Boolean] @option params :expires_in [Integer] @return [Mastodon::Filter]

# File lib/mastodon/rest/filters.rb, line 49
def update_filter(id, params = {})
  params[:'context[]'] = params.delete(:context) if params.key?(:context)
  perform_request_with_object(:put, "/api/v1/filters/#{id}", params, Mastodon::Filter)
end