chawk

package module

Go to main page

Versions in this module

v0

v0.8.20

Apr 8, 2026

v0.8.19

Apr 8, 2026

v0.8.18

Apr 8, 2026

Changes in this version

+ const HTTPTimeoutSeconds

+ const MaxResponseSize

v0.8.17

Apr 8, 2026

Changes in this version

+ var ErrNotAuthorized = errors.New("user not authorized to do this action")

type AnnouncementService

+ func (as *AnnouncementService) DeleteAnnouncements(ctx context.Context, courseID string) error

type BlackboardClient

+ func (c *BlackboardClient) SetUserAgent(name string)

type CourseCreateRequest

+ CourseID *string

type CourseService

+ func (cs *CourseService) CreateSimple(ctx context.Context, courseID string, title string, termID string) (*Course, error)

+ type GradeUpdate struct

+ Exempt *bool

+ Feedback *string

+ GradeNotationId *string

+ Notes *string

+ Score *int

+ Text *string

type User

+ func (user *User) FullName() string

+ func (user *User) FullNameLastFirst() string

v0.8.16

Mar 17, 2026

Changes in this version

+ const AvailabilityDisabled

+ const AvailabilityNo

+ const AvailabilityYes

+ const HTTP_TIMEOUT_SECS

+ const RoleCourseBuilder

+ const RoleFacilitator

+ const RoleGrader

+ const RoleGuest

+ const RoleInstructor

+ const RoleSpectator

+ const RoleStudent

+ const RoleTA

+ var ErrClientInitError = errors.New("clientID, clientSecret, and baseURL are required")

+ var ErrCourseExist = errors.New("course already exists")

+ var ErrCourseNotFound = errors.New("course doesn't exist")

+ var ErrEmptyStringParameter = errors.New("there is a parameter that is empty string")

+ var ErrInsufficientPrivileges = errors.New("insufficient privileges")

+ var ErrInvalidRole = errors.New("invalid course role")

+ var ErrInvalidUsername = errors.New("invalid username")

+ var ErrMissingName = errors.New("missing first and last name")

+ var ErrTokenExpired = errors.New("token expired")

+ var ErrTokenMissing = errors.New("token file missing")

+ var ErrUserAlreadyEnrolled = errors.New("user already enrolled in course, use UpdateMembership() if needed")

+ var ErrUserExist = errors.New("user already exists")

+ var ErrUserNotFound = errors.New("user account doesn't exist")

+ func OptionalString(value string) string

+ func RequiredString(value string, fieldName string) (string, error)

+ func ToPtr[T any](v T) *T

+ type Address struct

+ City string

+ Country string

+ State string

+ Street1 string

+ Street2 string

+ ZipCode string

+ type Announcement struct

+ Availability AnnouncementAvailability

+ Body string

+ Created string

+ Creator string

+ CreatorUserID string

+ Draft bool

+ ID string

+ Modified string

+ Position int

+ Title string

+ type AnnouncementAvailability struct

+ Duration Duration

+ type AnnouncementService struct

+ func (c *AnnouncementService) DeleteAllAnnouncements(ctx context.Context, courseID string) error

+ func (c *AnnouncementService) DeleteAnnouncement(ctx context.Context, courseID string, announcementID string) error

+ func (c *AnnouncementService) GetAllAnnouncements(ctx context.Context, courseID string) ([]Announcement, error)

+ func (c *AnnouncementService) GetAnnouncement(ctx context.Context, courseID string, announcementID string) (Announcement, error)

+ func (c *AnnouncementService) UpdateAnnouncement(ctx context.Context, courseID string, announcementID string) error

+ type Avatar struct

+ ResourceID string

+ Source string

+ UploadID string

+ type BlackboardClient struct

+ Announcement *AnnouncementService

+ BaseURL string

+ Courses *CourseService

+ Discussion *DiscussionService

+ Gradebook *GradebookService

+ UserAgent string

+ Users *UserService

+ func NewClient(clientID, clientSecret, baseURL string) (*BlackboardClient, error)

+ func (c *BlackboardClient) Delete(ctx context.Context, path string) (*http.Response, error)

+ func (c *BlackboardClient) Get(ctx context.Context, path string) (*http.Response, error)

+ func (c *BlackboardClient) GetRemainingCalls(ctx context.Context) (int, error)

+ func (c *BlackboardClient) Patch(ctx context.Context, path string, jsonBody interface{}) (*http.Response, error)

+ func (c *BlackboardClient) Post(ctx context.Context, path string, jsonBody interface{}) (*http.Response, error)

+ func (c *BlackboardClient) Put(ctx context.Context, path string, jsonBody interface{}) (*http.Response, error)

+ type ColumnAvailability struct

+ Available string

+ type ColumnScore struct

+ Possible float64

+ type Contact struct

+ BusinessFax string

+ BusinessPhone string

+ Email string

+ HomePhone string

+ InstitutionEmail string

+ MobilePhone string

+ WebPage string

+ type ContactUpdate struct

+ Email *string

+ InstitutionEmail *string

+ type CopyHistory struct

+ UUID string

+ type Course struct

+ AllowGuests bool

+ AllowObservers bool

+ Availability CourseAvailability

+ ClosedComplete bool

+ CopyHistory []CopyHistory

+ CourseID string

+ Created *time.Time

+ DataSourceID string

+ Description string

+ Enrollment Enrollment

+ ExternalAccessURL string

+ ExternalID string

+ GuestAccessURL string

+ HasChildren bool

+ ID string

+ IsChild bool

+ Locale CourseLocale

+ Modified *time.Time

+ Name string

+ Organization bool

+ ParentID string

+ TermID string

+ UUID string

+ UltraStatus string

+ type CourseAvailability struct

+ Available string

+ Duration CourseDuration

+ type CourseCreateRequest struct

+ Availability *CourseAvailability

+ DataSourceID *string

+ Description *string

+ ExternalID *string

+ Name *string

+ TermID *string

+ type CourseDuration struct

+ DaysOfUse int

+ End time.Time

+ Start time.Time

+ Type string

+ type CourseEnrollment struct

+ CourseID string

+ CourseRoleID string

+ Created time.Time

+ ExternalID string

+ Name string

+ type CourseLocale struct

+ Force bool

+ ID string

+ type CourseMembership struct

+ Availability *MembershipAvailability

+ ChildCourseID *string

+ CourseID string

+ CourseRoleID *string

+ Created time.Time

+ DataSourceID string

+ ID string

+ Modified time.Time

+ User *User

+ UserID string

+ type CourseService struct

+ func (cs *CourseService) AddChildCourse(ctx context.Context, courseID string, childID string) error

+ func (cs *CourseService) CopyCourseByCourseID(ctx context.Context, sourceID, destinationID string) (string, error)

+ func (cs *CourseService) Create(ctx context.Context, courseID string, title string, termID string) (*Course, error)

+ func (cs *CourseService) CreateMembership(ctx context.Context, username, courseID string, update EnrollmentRequest) error

+ func (cs *CourseService) CreatePro(ctx context.Context, req *CourseCreateRequest) (*Course, error)

+ func (cs *CourseService) DeleteCourse(ctx context.Context, courseID string) error

+ func (cs *CourseService) DoesCourseExist(ctx context.Context, courseID string) (bool, error)

+ func (cs *CourseService) EnrollUserIntoCourse(ctx context.Context, courseID string, username string, role string, ...) error

+ func (cs *CourseService) GetCourseByCourseId(ctx context.Context, courseID string) (*Course, error)

+ func (cs *CourseService) GetCourseById(ctx context.Context, id string) (*Course, error)

+ func (cs *CourseService) GetMembershipByID(ctx context.Context, userID string, courseID string) (*CourseMembership, error)

+ func (cs *CourseService) GetMembershipByUsername(ctx context.Context, username string, courseID string) (*CourseMembership, error)

+ func (cs *CourseService) GetUsers(ctx context.Context, courseID string) ([]CourseUser, error)

+ func (cs *CourseService) RemoveUser(ctx context.Context, courseID string, username string) error

+ func (cs *CourseService) Update(ctx context.Context, courseID string, req *CourseUpdateRequest) (*Course, error)

+ func (cs *CourseService) UpdateMembership(ctx context.Context, username, courseID string, update EnrollmentRequest) error

+ func (cs *CourseService) UpdateMembershipAvailability(ctx context.Context, username string, courseID string, availability string) error

+ type CourseUpdateRequest struct

+ Availability *CourseAvailability

+ DataSourceID *string

+ Description *string

+ Name *string

+ TermID *string

+ type CourseUser struct

+ Available string

+ CourseRoleID string

+ FirstName string

+ ID string

+ LastName string

+ UserName string

+ type CreateResult struct

+ Created []string

+ Failed []FailedOperation

+ func (r CreateResult) Error() string

+ func (r CreateResult) HasErrors() bool

+ func (r CreateResult) Summary() string

+ type DeleteResult struct

+ Deleted []string

+ Failed []FailedOperation

+ func (r DeleteResult) Error() string

+ func (r DeleteResult) HasErrors() bool

+ func (r DeleteResult) Summary() string

+ type DiscussionService struct

+ func (d *DiscussionService) DeleteStudentReplies(ctx context.Context, courseID string) (DeleteResult, error)

+ type Duration struct

+ End *string

+ Start *string

+ Type *string

+ type Enrollment struct

+ AccessCode string

+ End time.Time

+ Start time.Time

+ Type string

+ type EnrollmentRequest struct

+ Availability *MembershipAvailability

+ ChildCourseID *string

+ CourseRoleID *string

+ DataSourceID *string

+ DisplayOrder *int

+ type FailedOperation struct

+ Err error

+ ID string

+ type GradebookColumn struct

+ Availability ColumnAvailability

+ Created string

+ Description string

+ DisplayName string

+ ExternalID string

+ Grading GradebookGrading

+ ID string

+ IncludeInCalculations bool

+ Modified string

+ Name string

+ Score ColumnScore

+ ShowStatisticsToStudents bool

+ type GradebookGrading struct

+ AttemptsAllowed int

+ Due string

+ ScoringModel string

+ Type string

+ type GradebookService struct

+ func (gs *GradebookService) CreateColumn(ctx context.Context, courseID, name, description string, score float64) error

+ func (gs *GradebookService) CreateColumnPro(ctx context.Context, courseID string, column GradebookColumn) error

+ func (gs *GradebookService) DeleteColumn(ctx context.Context, courseID string, columnID string) error

+ func (gs *GradebookService) DeleteColumns(ctx context.Context, courseID string) error

+ func (gs *GradebookService) GetColumn(ctx context.Context, courseID string, columnID string) (*GradebookColumn, error)

+ func (gs *GradebookService) GetColumns(ctx context.Context, courseID string) ([]GradebookColumn, error)

+ func (gs *GradebookService) UpdateColumnPro(ctx context.Context, courseID string, columnID string) error

+ func (gs *GradebookService) UpdateColumnValue(ctx context.Context, courseID string, columnID string) error

+ type Job struct

+ Company string

+ Department string

+ Title string

+ type Locale struct

+ Calendar *string

+ FirstDayOfWeek *string

+ ID string

+ type MembershipAvailability struct

+ Available *string

+ type Name struct

+ Family string

+ Given string

+ Middle string

+ Other string

+ PreferredDisplayName string

+ Suffix string

+ Title string

+ type NameUpdate struct

+ Family *string

+ Given *string

+ type PronunciationAudio struct

+ UploadID string

+ type Token struct

+ AccessToken string

+ ExpiresIn int64

+ Expiry time.Time

+ RefreshToken string

+ TokenType string

+ func (t *Token) IsExpired() bool

+ type UpdateResult struct

+ Failed []FailedOperation

+ Updated []string

+ func (r UpdateResult) Error() string

+ func (r UpdateResult) HasErrors() bool

+ func (r UpdateResult) Summary() string

+ type User struct

+ Address Address

+ Availability UserAvailability

+ Avatar Avatar

+ BirthDate *time.Time

+ Contact Contact

+ DataSourceID string

+ EducationLevel string

+ ExternalID string

+ Gender string

+ ID string

+ InstitutionRoleIDs []string

+ Job Job

+ Locale Locale

+ Name Name

+ Password string

+ Pronouns string

+ Pronunciation string

+ PronunciationAudio PronunciationAudio

+ StudentID string

+ SystemRoleIDs []string

+ UUID string

+ UserName string

+ type UserAvailability struct

+ Available string

+ type UserService struct

+ func (s *UserService) DoesUserExist(ctx context.Context, username string) (bool, error)

+ func (us *UserService) AddInstitutionRoles(ctx context.Context, username string, roles []string) error

+ func (us *UserService) CreateUser(ctx context.Context, username string, fName string, lName string, email string, ...) error

+ func (us *UserService) Delete(ctx context.Context, username string) error

+ func (us *UserService) GetCourses(ctx context.Context, username string) ([]CourseEnrollment, error)

+ func (us *UserService) GetUserByUsername(ctx context.Context, username string) (*User, error)

+ func (us *UserService) Update(ctx context.Context, username string, update UserUpdate) error

+ func (us *UserService) UpdateEmail(ctx context.Context, username, newEmail string) error

+ func (us *UserService) UpdateInstitutionEmail(ctx context.Context, username, newEmail string) error

+ func (us *UserService) UpdateName(ctx context.Context, username, fName, lName string) error

+ func (us *UserService) UpdatePassword(ctx context.Context, username, newPassword string) error

+ func (us *UserService) UpdateUserAvailability(ctx context.Context, username string, availability string) error

+ type UserUpdate struct

+ Availability *UserAvailability

+ Contact *ContactUpdate

+ InstitutionRoleIDs []string

+ Name *NameUpdate

+ Password *string

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL