SearchResult

class canvasapi.searchresult.SearchResult(requester, attributes)

Represents a result (which can be of multiple types) return from the SmartSearch API.

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

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

resolve()

Resolve this SearchResult into the corresponding Canvas object.

Returns:

The full object (e.g., Page, Assignment, DiscussionTopic), or None if resolution fails.

Return type:

canvasapi.page.Page, canvasapi.assignment.Assignment, canvasapi.discussion_topic.DiscussionTopic