Module: DiscourseApi::API::Topics

Included in:
Client
Defined in:
lib/discourse_api/api/topics.rb

Instance Method Summary collapse

Instance Method Details

#bookmark_topic(topic_id) ⇒ Object 


109
110
111
 
# File 'lib/discourse_api/api/topics.rb', line 109

def bookmark_topic(topic_id)
  put("/t/#{topic_id}/bookmark.json")
end

#change_owner(topic_id, params = {}) ⇒ Object 


96
97
98
99
100
101
 
# File 'lib/discourse_api/api/topics.rb', line 96

def change_owner(topic_id, params = {})
  params = API.params(params)
    .required(:username, :post_ids)

  post("/t/#{topic_id}/change-owner.json", params)
end

#change_topic_status(topic_slug, topic_id, params = {}) ⇒ Object

TODO: Deprecated. Remove after 20201231


51
52
53
54
 
# File 'lib/discourse_api/api/topics.rb', line 51

def change_topic_status(topic_slug, topic_id, params = {})
  deprecated(__method__, 'update_topic_status')
  update_topic_status(topic_id, params)
end

#create_topic(args = {}) ⇒ Object

:category OPTIONAL name of category, not ID :skip_validations OPTIONAL boolean :auto_track OPTIONAL boolean :created_at OPTIONAL seconds since epoch.


9
10
11
12
13
14
 
# File 'lib/discourse_api/api/topics.rb', line 9

def create_topic(args = {})
  args = API.params(args)
    .required(:title, :raw)
    .optional(:skip_validations, :category, :auto_track, :created_at, :api_username, :tags)
  post("/posts", args.to_h)
end

#create_topic_action(args) ⇒ Object 


16
17
18
19
20
 
# File 'lib/discourse_api/api/topics.rb', line 16

def create_topic_action(args)
  args = API.params(args)
    .required(:id, :post_action_type_id)
  post("/post_actions", args.to_h.merge(flag_topic: true))
end

#delete_topic(id) ⇒ Object 


73
74
75
 
# File 'lib/discourse_api/api/topics.rb', line 73

def delete_topic(id)
  delete("/t/#{id}.json")
end

#edit_topic_timestamp(topic_id, timestamp) ⇒ Object

timestamp is seconds past the epoch.


23
24
25
 
# File 'lib/discourse_api/api/topics.rb', line 23

def edit_topic_timestamp(topic_id, timestamp)
  put("/t/#{topic_id}/change-timestamp", timestamp: timestamp)
end

#latest_topics(params = {}) ⇒ Object 


27
28
29
30
 
# File 'lib/discourse_api/api/topics.rb', line 27

def latest_topics(params = {})
  response = get('/latest.json', params)
  response[:body]['topic_list']['topics']
end

#new_topics(params = {}) ⇒ Object 


37
38
39
40
 
# File 'lib/discourse_api/api/topics.rb', line 37

def new_topics(params = {})
  response = get("/new.json", params)
  response[:body]['topic_list']['topics']
end

#recategorize_topic(topic_id, category_id) ⇒ Object 


46
47
48
 
# File 'lib/discourse_api/api/topics.rb', line 46

def recategorize_topic(topic_id, category_id)
  put("/t/#{topic_id}.json", topic_id: topic_id, category_id: category_id)
end

#remove_topic_bookmark(topic_id) ⇒ Object 


113
114
115
 
# File 'lib/discourse_api/api/topics.rb', line 113

def remove_topic_bookmark(topic_id)
  put("/t/#{topic_id}/remove_bookmarks.json")
end

#rename_topic(topic_id, title) ⇒ Object 


42
43
44
 
# File 'lib/discourse_api/api/topics.rb', line 42

def rename_topic(topic_id, title)
  put("/t/#{topic_id}.json", topic_id: topic_id, title: title)
end

#top_topics(params = {}) ⇒ Object 


32
33
34
35
 
# File 'lib/discourse_api/api/topics.rb', line 32

def top_topics(params = {})
  response = get("/top.json", params)
  response[:body]['topic_list']['topics']
end

#topic(id, params = {}) ⇒ Object 


63
64
65
66
 
# File 'lib/discourse_api/api/topics.rb', line 63

def topic(id, params = {})
  response = get("/t/#{id}.json", params)
  response[:body]
end

#topic_posts(topic_id, post_ids = [], params = {}) ⇒ Object 


77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/discourse_api/api/topics.rb', line 77

def topic_posts(topic_id, post_ids = [], params = {})
  params = API.params(params)
    .optional(:asc,
      :filter,
      :include_raw,
      :include_suggested,
      :post_number,
      :username_filters,
    )

  url = ["/t/#{topic_id}/posts.json"]
  if post_ids.count > 0
    url.push('?')
    url.push(post_ids.map { |id| "post_ids[]=#{id}" }.join('&'))
  end
  response = get(url.join, params)
  response[:body]
end

#topic_set_user_notification_level(topic_id, params) ⇒ Object 


103
104
105
106
107
 
# File 'lib/discourse_api/api/topics.rb', line 103

def topic_set_user_notification_level(topic_id, params)
  params = API.params(params)
    .required(:notification_level)
  post("/t/#{topic_id}/notifications", params)
end

#topics_by(username, params = {}) ⇒ Object 


68
69
70
71
 
# File 'lib/discourse_api/api/topics.rb', line 68

def topics_by(username, params = {})
  response = get("/topics/created-by/#{username}.json", params)
  response[:body]['topic_list']['topics']
end

#update_topic_status(topic_id, params = {}) ⇒ Object 


56
57
58
59
60
61
 
# File 'lib/discourse_api/api/topics.rb', line 56

def update_topic_status(topic_id, params = {})
  params = API.params(params)
    .required(:status, :enabled)
    .optional(:api_username)
  put("/t/#{topic_id}/status", params)
end