Module: Mastodon::REST::Statuses

Includes:
Utils
Included in:
API
Defined in:
lib/mastodon/rest/statuses.rb

Instance Method Summary collapse

Methods included from Utils

#array_param, #perform_request, #perform_request_with_collection, #perform_request_with_object

Instance Method Details

#create_status(text, in_reply_to_id = nil, media_ids = []) ⇒ Mastodon::Status

Create new status

Parameters:

  • text (String)
  • in_reply_to_id (Integer) (defaults to: nil)
  • media_ids (Array<Integer>) (defaults to: [])

Returns:



14
15
16
 
# File 'lib/mastodon/rest/statuses.rb', line 14

def create_status(text, in_reply_to_id = nil, media_ids = [])
  perform_request_with_object(:post, '/api/v1/statuses', array_param(:media_ids, media_ids).merge(status: text, in_reply_to_id: in_reply_to_id), Mastodon::Status)
end

#destroy_status(id) ⇒ Boolean

Destroy status

Parameters:

  • id (Integer)

Returns:

  • (Boolean) 


28
29
30
 
# File 'lib/mastodon/rest/statuses.rb', line 28

def destroy_status(id)
  !perform_request(:delete, "/api/v1/statuses/#{id}").nil?
end

#favourite(id) ⇒ Mastodon::Status

Favourite a status

Parameters:

  • id (Integer)

Returns:



49
50
51
 
# File 'lib/mastodon/rest/statuses.rb', line 49

def favourite(id)
  perform_request_with_object(:post, "/api/v1/statuses/#{id}/favourite", {}, Mastodon::Status)
end

#reblog(id) ⇒ Mastodon::Status

Reblog a status

Parameters:

  • id (Integer)

Returns:



35
36
37
 
# File 'lib/mastodon/rest/statuses.rb', line 35

def reblog(id)
  perform_request_with_object(:post, "/api/v1/statuses/#{id}/reblog", {}, Mastodon::Status)
end

#status(id) ⇒ Mastodon::Status

Retrieve status

Parameters:

  • id (Integer)

Returns:



21
22
23
 
# File 'lib/mastodon/rest/statuses.rb', line 21

def status(id)
  perform_request_with_object(:get, "/api/v1/statuses/#{id}", {}, Mastodon::Status)
end

#statuses(account_id, options = {}) ⇒ Mastodon::Collection<Mastodon::Status>

Get a list of statuses by a user

Parameters:

  • account_id (Integer)
  • options (Hash) (defaults to: {})

Options Hash (options):

  • :max_id (Integer)
  • :since_id (Integer)
  • :limit (Integer)

Returns:



67
68
69
 
# File 'lib/mastodon/rest/statuses.rb', line 67

def statuses(, options = {})
  perform_request_with_collection(:get, "/api/v1/accounts/#{}/statuses", options, Mastodon::Status)
end

#unfavourite(id) ⇒ Mastodon::Status

Undo a favourite of a status

Parameters:

  • id (Integer)

Returns:



56
57
58
 
# File 'lib/mastodon/rest/statuses.rb', line 56

def unfavourite(id)
  perform_request_with_object(:post, "/api/v1/statuses/#{id}/unfavourite", {}, Mastodon::Status)
end

#unreblog(id) ⇒ Mastodon::Status

Undo a reblog of a status

Parameters:

  • id (Integer)

Returns:



42
43
44
 
# File 'lib/mastodon/rest/statuses.rb', line 42

def unreblog(id)
  perform_request_with_object(:post, "/api/v1/statuses/#{id}/unreblog", {}, Mastodon::Status)
end