DiscussionEntry

class canvasapi.discussion_topic.DiscussionEntry(requester, attributes)

Parameters:

• requester (canvasapi.requester.Requester) – The requester to pass HTTP requests through.

• attributes (dict) – The JSON object to build this object with.

delete(**kwargs)

Delete this discussion entry.

Calls:

DELETE /api/v1/courses/:course_id/discussion_topics/:topic_id/entries/:id

or DELETE /api/v1/groups/:group_id/discussion_topics/:topic_id/entries/:id

Return type:

bool

get_discussion(**kwargs)

Return the discussion topic object this entry is related to

Return type:

canvasapi.discussion_topic.DiscussionTopic

get_replies(**kwargs)

Retrieves the replies to a top-level entry in a discussion topic.

Calls:

GET /api/v1/courses/:course_id/discussion_topics/:topic_id/entries/:entry_id/replies

or GET /api/v1/groups/:group_id/discussion_topics/:topic_id/entries/:entry_id/replies

Return type:

canvasapi.paginated_list.PaginatedList of canvasapi.discussion_topic.DiscussionEntry

mark_as_read(**kwargs)

Mark a discussion entry as read.

Calls:

PUT /api/v1/courses/:course_id/discussion_topics/:topic_id/entries/:entry_id/read

or PUT /api/v1/groups/:group_id/discussion_topics/:topic_id/entries/:entry_id/read

Return type:

bool

mark_as_unread(**kwargs)

Mark a discussion entry as unread.

Calls:

DELETE /api/v1/courses/:course_id/discussion_topics/:topic_id/entries/:entry_id/read

or DELETE /api/v1/groups/:group_id/discussion_topics/:topic_id/entries/:entry_id/read

Return type:

bool

post_reply(**kwargs)

Add a reply to this entry.

Calls:

POST /api/v1/courses/:course_id/discussion_topics/:topic_id/entries/:entry_id/replies

or POST /api/v1/groups/:group_id/discussion_topics/:topic_id/entries/:entry_id/replies

Return type:

canvasapi.discussion_topic.DiscussionEntry

rate(rating, **kwargs)

Rate this discussion entry.

Calls:

POST /api/v1/courses/:course_id/discussion_topics/:topic_id/entries/:entry_id/rating

or POST /api/v1/groups/:group_id/discussion_topics/:topic_id/entries/:entry_id/rating

Parameters:

rating (int) – A rating to set on this entry. Only 0 and 1 are accepted.

Return type:

bool

update(**kwargs)

Updates an existing discussion entry.

Calls:

PUT /api/v1/courses/:course_id/discussion_topics/:topic_id/entries/:id

or PUT /api/v1/groups/:group_id/discussion_topics/:topic_id/entries/:id

Return type:

bool