canvasapi
stable
Getting Started with CanvasAPI
Class Reference
canvasapi
Docs
»
Index
Edit on GitHub
Index
A
|
B
|
C
|
D
|
E
|
F
|
G
|
I
|
L
|
M
|
O
|
P
|
Q
|
R
|
S
|
T
|
U
A
Account (class in canvasapi.account)
AccountNotification (class in canvasapi.account)
AccountReport (class in canvasapi.account)
activate_role() (canvasapi.account.Account method)
add_authentication_providers() (canvasapi.account.Account method)
add_grading_standards() (canvasapi.account.Account method)
(canvasapi.course.Course method)
add_message() (canvasapi.conversation.Conversation method)
add_observee() (canvasapi.user.User method)
add_observee_with_credentials() (canvasapi.user.User method)
add_recipients() (canvasapi.conversation.Conversation method)
AppointmentGroup (class in canvasapi.appointment_group)
assign_members() (canvasapi.group.GroupCategory method)
Assignment (class in canvasapi.assignment)
AssignmentGroup (class in canvasapi.assignment)
AuthenticationProvider (class in canvasapi.authentication_provider)
Avatar (class in canvasapi.avatar)
B
Bookmark (class in canvasapi.bookmark)
C
CalendarEvent (class in canvasapi.calendar_event)
Canvas (class in canvasapi)
canvasapi.util (module)
CanvasObject (class in canvasapi.canvas_object)
clear_course_nicknames() (canvasapi.Canvas method)
close_notification_for_user() (canvasapi.account.Account method)
combine_kwargs() (in module canvasapi.util)
complete() (canvasapi.module.ModuleItem method)
conclude() (canvasapi.course.Course method)
Conversation (class in canvasapi.conversation)
conversations_batch_update() (canvasapi.Canvas method)
conversations_get_running_batches() (canvasapi.Canvas method)
conversations_mark_all_as_read() (canvasapi.Canvas method)
conversations_unread_count() (canvasapi.Canvas method)
Course (class in canvasapi.course)
CourseNickname (class in canvasapi.course)
create_account() (canvasapi.account.Account method)
(canvasapi.Canvas method)
create_appointment_group() (canvasapi.Canvas method)
create_assignment() (canvasapi.course.Course method)
create_assignment_group() (canvasapi.course.Course method)
create_bookmark() (canvasapi.current_user.CurrentUser method)
create_calendar_event() (canvasapi.Canvas method)
create_conversation() (canvasapi.Canvas method)
create_course() (canvasapi.account.Account method)
create_course_section() (canvasapi.course.Course method)
create_discussion_topic() (canvasapi.course.Course method)
(canvasapi.group.Group method)
create_enrollment_term() (canvasapi.account.Account method)
create_external_feed() (canvasapi.course.Course method)
(canvasapi.group.Group method)
create_external_tool() (canvasapi.account.Account method)
(canvasapi.course.Course method)
create_folder() (canvasapi.course.Course method)
(canvasapi.group.Group method)
(canvasapi.user.User method)
create_group() (canvasapi.Canvas method)
(canvasapi.group.GroupCategory method)
create_group_category() (canvasapi.account.Account method)
(canvasapi.course.Course method)
create_membership() (canvasapi.group.Group method)
create_module() (canvasapi.course.Course method)
create_module_item() (canvasapi.module.Module method)
create_notification() (canvasapi.account.Account method)
create_page() (canvasapi.course.Course method)
(canvasapi.group.Group method)
create_question_group() (canvasapi.quiz.Quiz method)
create_quiz() (canvasapi.course.Course method)
create_role() (canvasapi.account.Account method)
create_subaccount() (canvasapi.account.Account method)
create_subgroup() (canvasapi.outcome.OutcomeGroup method)
create_user() (canvasapi.account.Account method)
create_user_login() (canvasapi.account.Account method)
cross_list_section() (canvasapi.section.Section method)
CurrentUser (class in canvasapi.current_user)
D
deactivate_role() (canvasapi.account.Account method)
decross_list_section() (canvasapi.section.Section method)
delete() (canvasapi.account.Account method)
(canvasapi.appointment_group.AppointmentGroup method)
(canvasapi.assignment.Assignment method)
(canvasapi.assignment.AssignmentGroup method)
(canvasapi.authentication_provider.AuthenticationProvider method)
(canvasapi.bookmark.Bookmark method)
(canvasapi.calendar_event.CalendarEvent method)
(canvasapi.conversation.Conversation method)
(canvasapi.course.Course method)
(canvasapi.discussion_topic.DiscussionTopic method)
(canvasapi.enrollment_term.EnrollmentTerm method)
(canvasapi.external_tool.ExternalTool method)
(canvasapi.group.Group method)
(canvasapi.group.GroupCategory method)
(canvasapi.login.Login method)
(canvasapi.module.Module method)
(canvasapi.module.ModuleItem method)
(canvasapi.outcome.OutcomeGroup method)
(canvasapi.page.Page method)
(canvasapi.quiz.Quiz method)
(canvasapi.quiz.QuizGroup method)
(canvasapi.section.Section method)
delete_external_feed() (canvasapi.course.Course method)
(canvasapi.group.Group method)
delete_messages() (canvasapi.conversation.Conversation method)
delete_user() (canvasapi.account.Account method)
DiscussionTopic (class in canvasapi.discussion_topic)
E
edit() (canvasapi.appointment_group.AppointmentGroup method)
(canvasapi.assignment.Assignment method)
(canvasapi.assignment.AssignmentGroup method)
(canvasapi.bookmark.Bookmark method)
(canvasapi.calendar_event.CalendarEvent method)
(canvasapi.conversation.Conversation method)
(canvasapi.enrollment_term.EnrollmentTerm method)
(canvasapi.external_tool.ExternalTool method)
(canvasapi.group.Group method)
(canvasapi.login.Login method)
(canvasapi.module.Module method)
(canvasapi.module.ModuleItem method)
(canvasapi.page.Page method)
(canvasapi.quiz.Quiz method)
(canvasapi.section.Section method)
(canvasapi.user.User method)
edit_front_page() (canvasapi.course.Course method)
(canvasapi.group.Group method)
enroll_user() (canvasapi.course.Course method)
EnrollmentTerm (class in canvasapi.enrollment_term)
ExternalTool (class in canvasapi.external_tool)
F
flatten_kwarg() (in module canvasapi.util)
G
get_account() (canvasapi.Canvas method)
get_accounts() (canvasapi.Canvas method)
get_activity_stream_summary() (canvasapi.Canvas method)
(canvasapi.group.Group method)
get_all_outcome_links_in_context() (canvasapi.account.Account method)
(canvasapi.course.Course method)
get_appointment_group() (canvasapi.Canvas method)
get_assignment() (canvasapi.course.Course method)
get_assignment_group() (canvasapi.course.Course method)
get_assignments() (canvasapi.course.Course method)
(canvasapi.user.User method)
get_authentication_provider() (canvasapi.account.Account method)
get_avatars() (canvasapi.user.User method)
get_bookmark() (canvasapi.current_user.CurrentUser method)
get_calendar_event() (canvasapi.Canvas method)
get_color() (canvasapi.user.User method)
get_colors() (canvasapi.user.User method)
get_conversation() (canvasapi.Canvas method)
get_conversations() (canvasapi.Canvas method)
get_course() (canvasapi.Canvas method)
get_course_accounts() (canvasapi.Canvas method)
get_course_level_assignment_data() (canvasapi.course.Course method)
get_course_level_participation_data() (canvasapi.course.Course method)
get_course_level_student_summary_data() (canvasapi.course.Course method)
get_course_nickname() (canvasapi.Canvas method)
get_course_nicknames() (canvasapi.Canvas method)
get_courses() (canvasapi.account.Account method)
(canvasapi.Canvas method)
(canvasapi.user.User method)
get_department_level_grade_data_completed() (canvasapi.account.Account method)
get_department_level_grade_data_current() (canvasapi.account.Account method)
get_department_level_grade_data_with_given_term() (canvasapi.account.Account method)
get_department_level_participation_data_completed() (canvasapi.account.Account method)
get_department_level_participation_data_current() (canvasapi.account.Account method)
get_department_level_participation_data_with_given_term() (canvasapi.account.Account method)
get_department_level_statistics_completed() (canvasapi.account.Account method)
get_department_level_statistics_current() (canvasapi.account.Account method)
get_department_level_statistics_with_given_term() (canvasapi.account.Account method)
get_discussion_topic() (canvasapi.course.Course method)
(canvasapi.group.Group method)
get_discussion_topics() (canvasapi.course.Course method)
(canvasapi.group.Group method)
get_enrollment() (canvasapi.account.Account method)
get_enrollments() (canvasapi.course.Course method)
(canvasapi.section.Section method)
(canvasapi.user.User method)
get_external_tool() (canvasapi.account.Account method)
(canvasapi.course.Course method)
get_external_tools() (canvasapi.account.Account method)
(canvasapi.course.Course method)
get_file() (canvasapi.Canvas method)
(canvasapi.course.Course method)
(canvasapi.group.Group method)
(canvasapi.user.User method)
get_folder() (canvasapi.Canvas method)
(canvasapi.course.Course method)
(canvasapi.group.Group method)
(canvasapi.user.User method)
get_full_discussion_topic() (canvasapi.course.Course method)
(canvasapi.group.Group method)
get_grading_standards() (canvasapi.account.Account method)
(canvasapi.course.Course method)
get_group() (canvasapi.Canvas method)
get_group_category() (canvasapi.Canvas method)
get_index_of_reports() (canvasapi.account.Account method)
get_institution_url() (in module canvasapi.util)
get_membership() (canvasapi.group.Group method)
get_missing_submissions() (canvasapi.user.User method)
get_module() (canvasapi.course.Course method)
get_module_item() (canvasapi.module.Module method)
get_modules() (canvasapi.course.Course method)
get_outcome() (canvasapi.Canvas method)
(canvasapi.outcome.OutcomeLink method)
get_outcome_group() (canvasapi.account.Account method)
(canvasapi.Canvas method)
(canvasapi.course.Course method)
(canvasapi.outcome.OutcomeLink method)
get_outcome_groups_in_context() (canvasapi.account.Account method)
(canvasapi.course.Course method)
get_outcome_result_rollups() (canvasapi.course.Course method)
get_outcome_results() (canvasapi.course.Course method)
get_page() (canvasapi.course.Course method)
(canvasapi.group.Group method)
get_page_views() (canvasapi.user.User method)
get_pages() (canvasapi.course.Course method)
(canvasapi.group.Group method)
get_parent() (canvasapi.discussion_topic.DiscussionTopic method)
(canvasapi.external_tool.ExternalTool method)
(canvasapi.page.Page method)
(canvasapi.page.PageRevision method)
get_profile() (canvasapi.user.User method)
get_quiz() (canvasapi.course.Course method)
get_quiz_group() (canvasapi.quiz.Quiz method)
get_quizzes() (canvasapi.course.Course method)
get_recent_students() (canvasapi.course.Course method)
get_reports() (canvasapi.account.Account method)
get_revision_by_id() (canvasapi.page.Page method)
get_role() (canvasapi.account.Account method)
get_root_outcome_group() (canvasapi.account.Account method)
(canvasapi.Canvas method)
(canvasapi.course.Course method)
get_rubric() (canvasapi.account.Account method)
(canvasapi.course.Course method)
get_section() (canvasapi.Canvas method)
(canvasapi.course.Course method)
get_sessionless_launch_url() (canvasapi.external_tool.ExternalTool method)
get_settings() (canvasapi.course.Course method)
get_single_grading_standard() (canvasapi.account.Account method)
(canvasapi.course.Course method)
get_subaccounts() (canvasapi.account.Account method)
get_submission() (canvasapi.course.Course method)
(canvasapi.section.Section method)
get_todo_items() (canvasapi.Canvas method)
get_upcoming_events() (canvasapi.Canvas method)
get_user() (canvasapi.Canvas method)
(canvasapi.course.Course method)
get_user_in_a_course_level_assignment_data() (canvasapi.course.Course method)
get_user_in_a_course_level_messaging_data() (canvasapi.course.Course method)
get_user_in_a_course_level_participation_data() (canvasapi.course.Course method)
get_user_notifications() (canvasapi.account.Account method)
get_users() (canvasapi.account.Account method)
(canvasapi.course.Course method)
Group (class in canvasapi.group)
GroupCategory (class in canvasapi.group)
GroupMembership (class in canvasapi.group)
I
import_outcome_group() (canvasapi.outcome.OutcomeGroup method)
invite() (canvasapi.group.Group method)
is_multivalued() (in module canvasapi.util)
L
link_existing() (canvasapi.outcome.OutcomeGroup method)
link_new() (canvasapi.outcome.OutcomeGroup method)
list_appointment_groups() (canvasapi.Canvas method)
list_assignment_groups() (canvasapi.course.Course method)
list_authentication_providers() (canvasapi.account.Account method)
list_bookmarks() (canvasapi.current_user.CurrentUser method)
list_calendar_events() (canvasapi.Canvas method)
list_calendar_events_for_user() (canvasapi.user.User method)
list_communication_channels() (canvasapi.user.User method)
list_enrollment_terms() (canvasapi.account.Account method)
list_entries() (canvasapi.discussion_topic.DiscussionTopic method)
list_external_feeds() (canvasapi.course.Course method)
(canvasapi.group.Group method)
list_files() (canvasapi.course.Course method)
(canvasapi.group.Group method)
(canvasapi.user.User method)
list_folders() (canvasapi.course.Course method)
(canvasapi.group.Group method)
(canvasapi.user.User method)
list_gradeable_students() (canvasapi.course.Course method)
list_group_categories() (canvasapi.account.Account method)
(canvasapi.course.Course method)
list_group_participants() (canvasapi.Canvas method)
list_groups() (canvasapi.account.Account method)
(canvasapi.course.Course method)
(canvasapi.current_user.CurrentUser method)
(canvasapi.group.GroupCategory method)
list_linked_outcomes() (canvasapi.outcome.OutcomeGroup method)
list_memberships() (canvasapi.group.Group method)
list_module_items() (canvasapi.module.Module method)
list_multiple_submissions() (canvasapi.course.Course method)
(canvasapi.section.Section method)
list_observees() (canvasapi.user.User method)
list_revisions() (canvasapi.page.Page method)
list_roles() (canvasapi.account.Account method)
list_rubrics() (canvasapi.account.Account method)
(canvasapi.course.Course method)
list_sections() (canvasapi.course.Course method)
list_subgroups() (canvasapi.outcome.OutcomeGroup method)
list_submissions() (canvasapi.course.Course method)
(canvasapi.section.Section method)
list_tabs() (canvasapi.course.Course method)
(canvasapi.group.Group method)
list_topic_entries() (canvasapi.discussion_topic.DiscussionTopic method)
list_user_logins() (canvasapi.account.Account method)
(canvasapi.user.User method)
list_user_participants() (canvasapi.Canvas method)
list_users() (canvasapi.group.Group method)
(canvasapi.group.GroupCategory method)
Login (class in canvasapi.login)
M
mark_as_read() (canvasapi.discussion_topic.DiscussionTopic method)
mark_as_unread() (canvasapi.discussion_topic.DiscussionTopic method)
mark_entries_as_read() (canvasapi.discussion_topic.DiscussionTopic method)
mark_entries_as_unread() (canvasapi.discussion_topic.DiscussionTopic method)
mark_submission_as_read() (canvasapi.course.Course method)
(canvasapi.section.Section method)
mark_submission_as_unread() (canvasapi.course.Course method)
(canvasapi.section.Section method)
merge_into() (canvasapi.user.User method)
Module (class in canvasapi.module)
ModuleItem (class in canvasapi.module)
O
obj_or_id() (in module canvasapi.util)
Outcome (class in canvasapi.outcome)
OutcomeGroup (class in canvasapi.outcome)
OutcomeLink (class in canvasapi.outcome)
P
Page (class in canvasapi.page)
PageRevision (class in canvasapi.page)
parent_id (canvasapi.external_tool.ExternalTool attribute)
(canvasapi.page.Page attribute)
(canvasapi.page.PageRevision attribute)
parent_type (canvasapi.external_tool.ExternalTool attribute)
(canvasapi.page.Page attribute)
(canvasapi.page.PageRevision attribute)
post_entry() (canvasapi.discussion_topic.DiscussionTopic method)
preview_html() (canvasapi.course.Course method)
(canvasapi.group.Group method)
Progress (class in canvasapi.progress)
Q
query() (canvasapi.progress.Progress method)
Quiz (class in canvasapi.quiz)
QuizGroup (class in canvasapi.quiz)
R
relock() (canvasapi.module.Module method)
remove() (canvasapi.course.CourseNickname method)
remove_observee() (canvasapi.user.User method)
remove_self() (canvasapi.group.GroupMembership method)
remove_user() (canvasapi.group.Group method)
(canvasapi.group.GroupMembership method)
reorder_pinned_topics() (canvasapi.course.Course method)
(canvasapi.group.Group method)
reorder_question_group() (canvasapi.quiz.QuizGroup method)
request() (canvasapi.requester.Requester method)
request_upload_token() (canvasapi.upload.Uploader method)
Requester (class in canvasapi.requester)
reserve_time_slot() (canvasapi.Canvas method)
reset() (canvasapi.course.Course method)
revert_to_revision() (canvasapi.page.Page method)
Role (class in canvasapi.account)
Rubric (class in canvasapi.rubric)
S
search_accounts() (canvasapi.Canvas method)
search_all_courses() (canvasapi.Canvas method)
search_recipients() (canvasapi.Canvas method)
Section (class in canvasapi.section)
set_attributes() (canvasapi.canvas_object.CanvasObject method)
set_course_nickname() (canvasapi.Canvas method)
show_account_auth_settings() (canvasapi.account.Account method)
show_front_page() (canvasapi.course.Course method)
(canvasapi.group.Group method)
show_latest_revision() (canvasapi.page.Page method)
show_observee() (canvasapi.user.User method)
SSOSettings (class in canvasapi.account)
start() (canvasapi.upload.Uploader method)
Submission (class in canvasapi.submission)
submit_assignment() (canvasapi.course.Course method)
(canvasapi.section.Section method)
subscribe() (canvasapi.discussion_topic.DiscussionTopic method)
T
to_json() (canvasapi.canvas_object.CanvasObject method)
U
uncomplete() (canvasapi.module.ModuleItem method)
unlink_outcome() (canvasapi.outcome.OutcomeGroup method)
unsubscribe() (canvasapi.discussion_topic.DiscussionTopic method)
update() (canvasapi.account.Account method)
(canvasapi.authentication_provider.AuthenticationProvider method)
(canvasapi.course.Course method)
(canvasapi.discussion_topic.DiscussionTopic method)
(canvasapi.group.GroupCategory method)
(canvasapi.group.GroupMembership method)
(canvasapi.outcome.Outcome method)
(canvasapi.outcome.OutcomeGroup method)
(canvasapi.quiz.QuizGroup method)
update_account_auth_settings() (canvasapi.account.Account method)
update_color() (canvasapi.user.User method)
update_membership() (canvasapi.group.Group method)
update_role() (canvasapi.account.Account method)
update_settings() (canvasapi.course.Course method)
(canvasapi.user.User method)
update_submission() (canvasapi.course.Course method)
(canvasapi.section.Section method)
update_tab() (canvasapi.course.Course method)
upload() (canvasapi.course.Course method)
(canvasapi.group.Group method)
(canvasapi.upload.Uploader method)
(canvasapi.user.User method)
upload_comment() (canvasapi.submission.Submission method)
Uploader (class in canvasapi.upload)
User (class in canvasapi.user)
Read the Docs
v: stable
Versions
latest
stable
Downloads
pdf
htmlzip
epub
On Read the Docs
Project Home
Builds
Free document hosting provided by
Read the Docs
.