module Mastodon::REST::Statuses

Public Instance Methods

create_status(text, params = {}) click to toggle source

Create new status @param text [String] @param params [Hash] @option params :in_reply_to_id [Integer] @option params :media_ids [Array<Integer>] @option params :visibility [String] @option params :language [String] @option params :sensitive [Boolean] @option params :spoiler_text [String] @option params :scheduled_at [String] @return <Mastodon::Status>

# File lib/mastodon/rest/statuses.rb, line 20
def create_status(text, params = {})
  params[:status]        = text
  params[:'media_ids[]'] = params.delete(:media_ids) if params.key?(:media_ids)

  perform_request_with_object(:post, '/api/v1/statuses', params, Mastodon::Status)
end
destroy_status(id) click to toggle source

Destroy status @param id [Integer] @return [Boolean]

# File lib/mastodon/rest/statuses.rb, line 37
def destroy_status(id)
  !perform_request(:delete, "/api/v1/statuses/#{id}").nil?
end
favourite(id) click to toggle source

Favourite a status @param id [Integer] @return [Mastodon::Status]

# File lib/mastodon/rest/statuses.rb, line 58
def favourite(id)
  perform_request_with_object(:post, "/api/v1/statuses/#{id}/favourite", {}, Mastodon::Status)
end
favourited_by(id, options = {}) click to toggle source

Get a list of accounts that favourited a toot @param id [Integer] @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::Account>]

# File lib/mastodon/rest/statuses.rb, line 89
def favourited_by(id, options = {})
  perform_request_with_collection(:get, "/api/v1/statuses/#{id}/favourited_by", options, Mastodon::Account)
end
pin(id) click to toggle source

Pin status on own profile @param id [Integer] @return [Mastodon::Status]

# File lib/mastodon/rest/statuses.rb, line 96
def pin(id)
  perform_request_with_object(:post, "/api/v1/statuses/#{id}/pin", {}, Mastodon::Status)
end
reblog(id) click to toggle source

Reblog a status @param id [Integer] @return [Mastodon::Status]

# File lib/mastodon/rest/statuses.rb, line 44
def reblog(id)
  perform_request_with_object(:post, "/api/v1/statuses/#{id}/reblog", {}, Mastodon::Status)
end
reblogged_by(id, options = {}) click to toggle source

Get a list of accounts that reblogged a toot @param id [Integer] @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::Account>]

# File lib/mastodon/rest/statuses.rb, line 77
def reblogged_by(id, options = {})
  perform_request_with_collection(:get, "/api/v1/statuses/#{id}/reblogged_by", options, Mastodon::Account)
end
status(id) click to toggle source

Retrieve status @param id [Integer] @return [Mastodon::Status]

# File lib/mastodon/rest/statuses.rb, line 30
def status(id)
  perform_request_with_object(:get, "/api/v1/statuses/#{id}", {}, Mastodon::Status)
end
statuses(account_id, options = {}) click to toggle source

Get a list of statuses by a user @param account_id [Integer] @param options [Hash] @option options :max_id [Integer] @option options :since_id [Integer] @option options :min_id [Integer] @option options :limit [Integer] @option options :only_media [Boolean] @option options :pinned [Boolean] @option options :exclude_replies [Boolean] @option options :exclude_reblogs [Boolean] @return [Mastodon::Collection<Mastodon::Status>]

# File lib/mastodon/rest/statuses.rb, line 119
def statuses(account_id, options = {})
  perform_request_with_collection(:get, "/api/v1/accounts/#{account_id}/statuses", options, Mastodon::Status)
end
unfavourite(id) click to toggle source

Undo a favourite of a status @param id [Integer] @return [Mastodon::Status]

# File lib/mastodon/rest/statuses.rb, line 65
def unfavourite(id)
  perform_request_with_object(:post, "/api/v1/statuses/#{id}/unfavourite", {}, Mastodon::Status)
end
unpin(id) click to toggle source

Unpin status from own profile @param id [Integer] @return [Mastodon::Status]

# File lib/mastodon/rest/statuses.rb, line 103
def unpin(id)
  perform_request_with_object(:post, "/api/v1/statuses/#{id}/unpin", {}, Mastodon::Status)
end
unreblog(id) click to toggle source

Undo a reblog of a status @param id [Integer] @return [Mastodon::Status]

# File lib/mastodon/rest/statuses.rb, line 51
def unreblog(id)
  perform_request_with_object(:post, "/api/v1/statuses/#{id}/unreblog", {}, Mastodon::Status)
end