Forums#

forum_create_topic(self, forum_id, title, body, *, poll=None)#

https://osu.ppy.sh/docs/index.html#create-topic

Note

This endpoint requires the Scope.FORUM_WRITE scope.

Parameters:
Return type:

CreateForumTopicResponse

forum_edit_post(self, post_id, body)#

Edit a forum post.

Parameters:

  • post_id (int) – The post to edit.

  • body (str) – The new content of the post.

Return type:

ForumPost

Notes

Implements the Edit Post endpoint.

Note

This endpoint requires the Scope.FORUM_WRITE scope.

forum_edit_topic(self, topic_id, title)#

Edit a forum topic.

Parameters:

  • topic_id (int) – The topic to edit.

  • title (str) – The new title of the topic.

Return type:

ForumTopic

Notes

Implements the Edit Topic endpoint.

Note

This endpoint requires the Scope.FORUM_WRITE scope.

forum_reply(self, topic_id, body)#

Reply to a forum topic.

Parameters:

  • topic_id (int) – The topic to reply to.

  • body (str) – Content of the reply.

Return type:

ForumPost

Notes

Implements the Reply Topic endpoint.

Note

This endpoint requires the Scope.FORUM_WRITE scope.

forum_topic(self, topic_id, *, cursor_string=None, sort=None, limit=None, start=None, end=None)#

Get a forum topic and its posts.

Parameters:

  • topic_id (int) – The topic to get.

  • cursor_string (str | None) – Cursor for pagination.

  • sort (ForumTopicSort | str | None) – How to sort the posts.

  • limit (int | None) – Maximum number of posts to return.

  • start (int | None) – First post id to be returned when sort is ForumTopicSort.NEW. Ignored otherwise.

  • end (int | None) – First post id to be returned when sort is ForumTopicSort.OLD. Ignored otherwise.

Return type:

ForumTopicAndPosts

Notes

Implements the Get Topic and Posts endpoint.