▼NUVACanvasAccess | |
▼NApiParts | |
►CApi | This class is the primary interface for interacting with the Canvas API.
|
CColumnEntryUpdate | Represents one update to a custom column entry |
CQuotaInfo | Contains the total storage quota and quota usage for a user |
▼NBuilders | |
CAppointmentGroupBuilder | A class used to create or edit appointment groups using the builder pattern. When all desired fields are set, call Post to execute the operation |
CAssignmentBuilder | A class used to create or edit assignments using the builder pattern. When all desired fields are set, call Post to execute the operation |
CAssignmentOverrideBuilder | A class used to create or edit assignment overrides using the builder pattern. When all desired fields are set, call Post to execute the operation |
CCourseBuilder | Used to create courses using the builder pattern. When all desired fields are set, call Post to execute the operation |
CCreateDiscussionTopicBuilder | A class used to create new DiscussionTopics using the builder pattern. When all desired fields are set, call Post to create the topic |
CCreateUserBuilder | A class used to create new Users using the builder pattern. When all desired fields are set, call Post to create the user |
NDebugging | |
▼NExceptions | |
CBadApiStateException | Indicates that an operation failed due to bad state, or because completing it would result in a bad state |
CCommunicationException | Indicates a generic HTTP failure response. If the API replied with a JSON error body, it is included |
CDoesNotExistException | Indicates that some operation failed because the target thereof does not exist or is invisible to the current user |
▼NModel | |
NAccounts | |
NAnalytics | |
NAppointments | |
NAssignments | |
NAuthentications | |
NCalendar | |
NContentShares | |
NConversations | |
NCourses | |
NCustomGradebookColumns | |
NDiscussions | |
NEnrollments | |
NEnrollmentTerms | |
NExternalTools | |
NFiles | |
NGradebook | |
NGradeChangelog | |
NGradingPeriods | |
NGradingPeriodSets | |
NGroups | |
NLogins | |
NModules | |
NOutcomeResults | |
NPages | |
NProficiencyRatings | |
NQuizzes | |
NReports | |
NResults | |
NRoles | |
NSections | |
NSisImports | |
NSubmissions | |
NToDos | |
NUsers | |
▼NStructures | |
►NAccounts | |
CAccount | Represents a Canvas account |
CHelpLink | Represents an account help link |
CHelpLinks | Represents the set of default and custom help links for an account |
CTermsOfService | Represents the active Terms of Service for an account |
►NAnalytics | |
CCourseAssignmentSummary | A summary of per-assignment statistical information for a course |
CCourseStudentSummary | A summary of per-user participation information for a course |
►CDepartmentParticipation | Represents department-level participation data/page views |
CCategories | A category-grouped entry in a DepartmentParticipation |
CDateEntry | A date-grouped entry in a DepartmentParticipation |
CDepartmentStatistics | Represents numerical department-level statistics |
CTardiness | Represents a tardiness summary. Depending on the context, the values may be percentages out of 1 or absolute values |
CUserAssignmentData | Assignment statistics for a single user and single assignment |
CUserAssignmentSubmissionData | One user score in a UserAssignmentData |
CUserParticipation | Participation statistics for one user in a course |
CUserParticipationEvent | A single page hit in a UserParticipation |
►NAppointments | |
CAppointment | Represents an appointment |
CAppointmentGroup | Represents an appointment group |
►NAssignments | |
CAssignment | Represents an assignment |
CAssignmentDate | Represents the set of dates applicable to an assignment |
CAssignmentOverride | Represents a change in dates for an assignment for a subset of students |
CExternalToolTagAttributes | |
CLockInfo | Details about an assignment or file lock |
CNeedsGradingCount | A count of how many assignments need to be graded within a section |
CRubricCriteria | Represents some rubric criteria |
CRubricRating | Represents one rating as part of a rubric criterion |
CTurnitinSettings | Represents TurnItIn settings |
►NAuthentications | |
CAuthenticationEvent | An authentication (login/logout) event |
►NCalendar | |
CBasicCalendarEvent | |
CCalendarEvent | Represents a calendar event |
CEventContext | |
CTimeSlotCalendarEvent | Represents a possible time-slot appointment within an appointment group. Actual reserved appointments within this time-slot are represented by UserReservationCalendarEvent |
CUserReservationCalendarEvent | Represents a user appointment within a TimeSlotCalendarEvent of an appointment group |
►NContentShares | |
CContentShare | Represents a content share between a sender and one or more receivers |
CContentShareWithSender | Represents a content share along with the sender |
CContentShareWithReceivers | Represents a content share along with the list of receivers |
►NConversations | |
CConversation | Summarizes a conversation thread between 2 or more users |
CConversationMessage | Represents a message in a Conversation |
CConversationParticipant | |
CDetailedConversation | Fully represents a conversation thread between 2 or more users |
►NCourses | |
CCourse | Represents a course |
CCourseProgress | |
CCourseSettings | Represents a certain subset of settings for a course |
CTerm | Represents an enrollment term |
►NCustomGradebookColumns | |
CColumnDatum | Represents an entry for a user in a custom gradebook column |
CCustomColumn | Represents a custom gradebook column |
►NDiscussions | |
CDiscussionTopic | Represents a discussion topic |
CFileAttachment | |
CTopicEntry | |
CTopicReply | |
►NEnrollments | |
CEnrollment | Represents an enrollment of a user in a course |
CGrade | Represents a student's grade in a course enrollment |
►NEnrollmentTerms | |
CEnrollmentTerm | Represents an enrollment term, or simply term |
CEnrollmentTermDateOverride | Represents a date override for a specific enrollment type within a term |
CEnrollmentTermBuilder | |
►NExternalTools | |
CAccountNavigationLocation | |
CCourseHomeSubNavigationLocation | |
CCourseNavigationLocation | |
CEditorButtonLocation | |
CExternalTool | |
CExternalToolLocation | |
CHomeworkSubmissionLocation | |
CLinkSelectionLocation | |
CMigrationSelectionLocation | |
CResourceSelectionLocation | |
CToolConfigurationLocation | |
CUserNavigationLocation | |
►NFiles | |
CCanvasFile | Represents a file present on the Canvas server |
CFolder | Represents a folder on the Canvas server. Folders contain CanvasFiles |
CLicense | Represents a content license |
CUsageRights | |
►NGradebook | |
CDay | |
CGrader | |
CSubmissionHistory | |
CSubmissionVersion | Represents one version of a Submission as part of an overall version history |
►NGradeChangelog | |
CGradeChangeEvent | |
CGradeChangeEventLinks | |
►NGradingPeriods | |
CGradingPeriod | Represents a grading period |
CGradingPeriodUpdate | Used to perform batch grading period updates.
Each object represents one updated or newly-created grading period |
►NGradingPeriodSets | |
CGradingPeriodSet | Represents a grading period set |
►NGroups | |
CGroup | |
CGroupMembership | |
►NLogins | |
CUserLogin | Represents a user login, i.e. an identity used to authenticate with Canvas |
►NModules | |
CCompletionRequirement | |
CContentDetails | |
CModule | |
CModuleItem | |
CModuleItemSequence | |
CModuleItemSequenceNode | |
►NPages | |
CPage | |
CPageRevision | |
►NProficiencyRatings | |
CProficiency | |
CProficiencyRating | |
►NQuizzes | |
CQuiz | Represents a quiz |
CQuizPermissions | |
►NReports | |
CReport | |
CReportDescription | |
CReportParameterDescription | |
►NResults | |
CResult | |
►NRoles | |
CRole | |
CRolePermissions | |
CRolePermissionsSet | |
CBasicAccountPermissionsSet | |
►NSections | |
CSection | Represents a section in a course |
►NSisImports | |
CSisImport | Represents a SIS import job |
CSisImportCounts | Counts of processed rows per import category in a SIS import |
CSisImportData | Represents some metadata of a SIS import |
CSisImportMessage | Represents an error or warning in a SIS import |
CSisImportStatistic | An individual statistic for an item in SisImportStatistics |
CSisImportStatistics | Counts for which types of items were added, deleted, and changed in a SIS import |
►NSubmissions | |
►NNewSubmission | |
CINewSubmissionContent | Represents some content to be submitted as part of an assignment submission |
COnlineTextEntrySubmission | Represents the submission of text, as if it was entered into the online interface |
COnlineUploadSubmission | Represents the submission of one or more previously uploaded files |
COnlineUrlSubmission | Represents the submission of a URL |
CMediaComment | Represents a media/attachment comment |
CSubmission | Represents an assignment submission |
CSubmissionComment | |
►NToDos | |
CToDoItem | |
CAssignmentToDoItem | |
CQuizToDoItem | |
►NUsers | |
►CActivityStreamObject | |
CAnnouncement | |
CAssignmentRequest | |
CCollaboration | |
CConference | |
CConversation | |
CDiscussionTopic | |
CMessage | |
CSubmissionObject | |
CActivityStreamSummaryEntry | |
CPageView | Represents a record of a user page view request |
CPageViewLinks | Represents relationships in a PageView |
CProfile | |
CShortUser | A short representation of a user |
CUser | Represents a user |
CUserDisplay | A limited representation of a User |
CQualifiedId | |
▼NUtil | |
CIAppointmentGroupParticipant | Indicates that implementing classes can be participants in an appointment group |
CIPrettyPrint | Classes implementing this interface provide an implementation for formatted output in the form of: |
COptIn | Indicates that the annotated property is null or absent by default, and must be explicitly included by an include parameter |