A class used to create new DiscussionTopics using the builder pattern. When all desired fields are set, call Post to create the topic. More...

Public Member Functions
CreateDiscussionTopicBuilder	WithTitle (string title)
	The title. More...

CreateDiscussionTopicBuilder	WithMessage (string message)
	The message. More...

CreateDiscussionTopicBuilder	WithDiscussionType (string type)
	`The type of discussion. Defaults to side_comment if not value is given. Accepted values are 'side_comment', for discussions that only allow one level of nested comments, and 'threaded' for fully threaded discussions.` More...

CreateDiscussionTopicBuilder	WithPublishedStatus (bool published=true)
	If the topic should be published or remain a draft. By default, if the current user is a teacher or a TA, the topic will remain a draft. Otherwise, the topic will be published. More...

CreateDiscussionTopicBuilder	WithDelayedPosting (DateTime postAt)
	If set, the topic will not be published until this time. More...

CreateDiscussionTopicBuilder	WithRatingsAllowed (bool allowed=true)
	Whether or not users are allowed to rate entries under this topic. More...

CreateDiscussionTopicBuilder	WithScheduledLock (DateTime lockAt)
	If set, the topic will lock itself at this time. More...

CreateDiscussionTopicBuilder	WithPodcastEnabled (bool enabled=true)
	If enabled, the topic will have a podcast feed. More...

CreateDiscussionTopicBuilder	WithPodcastIncludingStudents (bool enabled=true)
	If enabled, the topic will have a podcast feed that includes student posts. More...

CreateDiscussionTopicBuilder	WithRequiredInitialPost (bool require=true)
	If enabled, users cannot reply to other replies until they themselves have posted a reply. More...

CreateDiscussionTopicBuilder	WithAssignment (object o)
	Not yet supported. More...

CreateDiscussionTopicBuilder	AsAnnouncement (bool isAnnouncement=true)
	If enabled, this topic will appear in students' announcements section. More...

CreateDiscussionTopicBuilder	AsPinned (bool pinned=true)
	If true, this topic will appear in students' pinned discussions section. More...

CreateDiscussionTopicBuilder	WithPositionAfter (string id)
	By default, topics are sorted chronologically. If set, this topic will instead appear after a specific topic. More...

CreateDiscussionTopicBuilder	WithGroupCategory (uint id)
	If set, this topic will become a group discussion. More...

CreateDiscussionTopicBuilder	WithGraderRatingsOnly (bool graderRatingsOnly=true)
	If set, only graders will be able to rate entries. More...

CreateDiscussionTopicBuilder	WithSortingByRating (bool sortByRating=true)
	If set, entries will be sorted by rating. More...

CreateDiscussionTopicBuilder	WithAttachment ()
	Not yet supported. More...

CreateDiscussionTopicBuilder	WithSpecificSections (IEnumerable< ulong > sections)
	If this topic is an announcement, lives in a course, and this is set, the topic will only appear to these specific sections. More...

Task< DiscussionTopic >	Post ()
	Creates the new discussion topic. More...

Detailed Description

A class used to create new DiscussionTopics using the builder pattern. When all desired fields are set, call Post to create the topic.

Member Function Documentation

◆ AsAnnouncement()

CreateDiscussionTopicBuilder UVACanvasAccess.Builders.CreateDiscussionTopicBuilder.AsAnnouncement ( bool isAnnouncement = true )

inline

If enabled, this topic will appear in students' announcements section.

Parameters

isAnnouncement

Returns

◆ AsPinned()

CreateDiscussionTopicBuilder UVACanvasAccess.Builders.CreateDiscussionTopicBuilder.AsPinned ( bool pinned = true )

inline

If true, this topic will appear in students' pinned discussions section.

Parameters

pinned

Returns

◆ Post()

Task<DiscussionTopic> UVACanvasAccess.Builders.CreateDiscussionTopicBuilder.Post ( )

inline

Creates the new discussion topic.

Returns: The new discussion topic.

◆ WithAssignment()

CreateDiscussionTopicBuilder UVACanvasAccess.Builders.CreateDiscussionTopicBuilder.WithAssignment ( object o )

inline

Not yet supported.

Parameters

o

Returns

Exceptions

NotImplementedException

◆ WithAttachment()

CreateDiscussionTopicBuilder UVACanvasAccess.Builders.CreateDiscussionTopicBuilder.WithAttachment ( )

inline

Not yet supported.

Returns

Exceptions

NotImplementedException

◆ WithDelayedPosting()

CreateDiscussionTopicBuilder UVACanvasAccess.Builders.CreateDiscussionTopicBuilder.WithDelayedPosting ( DateTime postAt )

inline

If set, the topic will not be published until this time.

Parameters

postAt

Returns

◆ WithDiscussionType()

CreateDiscussionTopicBuilder UVACanvasAccess.Builders.CreateDiscussionTopicBuilder.WithDiscussionType ( string type )

inline

The type of discussion. Defaults to side_comment if not value is given. Accepted values are 'side_comment', for discussions that only allow one level of nested comments, and 'threaded' for fully threaded discussions.

Parameters

type

Returns

◆ WithGraderRatingsOnly()

CreateDiscussionTopicBuilder UVACanvasAccess.Builders.CreateDiscussionTopicBuilder.WithGraderRatingsOnly ( bool graderRatingsOnly = true )

inline

If set, only graders will be able to rate entries.

Parameters

graderRatingsOnly

Returns

◆ WithGroupCategory()

CreateDiscussionTopicBuilder UVACanvasAccess.Builders.CreateDiscussionTopicBuilder.WithGroupCategory ( uint id )

inline

If set, this topic will become a group discussion.

Parameters

id

Returns

◆ WithMessage()

CreateDiscussionTopicBuilder UVACanvasAccess.Builders.CreateDiscussionTopicBuilder.WithMessage ( string message )

inline

The message.

Parameters

message

Returns

◆ WithPodcastEnabled()

CreateDiscussionTopicBuilder UVACanvasAccess.Builders.CreateDiscussionTopicBuilder.WithPodcastEnabled ( bool enabled = true )

inline

If enabled, the topic will have a podcast feed.

Parameters

enabled

Returns

◆ WithPodcastIncludingStudents()

CreateDiscussionTopicBuilder UVACanvasAccess.Builders.CreateDiscussionTopicBuilder.WithPodcastIncludingStudents ( bool enabled = true )

inline

If enabled, the topic will have a podcast feed that includes student posts.

Parameters

enabled

Returns

◆ WithPositionAfter()

CreateDiscussionTopicBuilder UVACanvasAccess.Builders.CreateDiscussionTopicBuilder.WithPositionAfter ( string id )

inline

By default, topics are sorted chronologically. If set, this topic will instead appear after a specific topic.

Parameters

id

Returns

◆ WithPublishedStatus()

CreateDiscussionTopicBuilder UVACanvasAccess.Builders.CreateDiscussionTopicBuilder.WithPublishedStatus ( bool published = true )

inline

If the topic should be published or remain a draft. By default, if the current user is a teacher or a TA, the topic will remain a draft. Otherwise, the topic will be published.

Parameters

published

Returns

◆ WithRatingsAllowed()

CreateDiscussionTopicBuilder UVACanvasAccess.Builders.CreateDiscussionTopicBuilder.WithRatingsAllowed ( bool allowed = true )

inline

Whether or not users are allowed to rate entries under this topic.

Parameters

allowed

Returns

◆ WithRequiredInitialPost()

CreateDiscussionTopicBuilder UVACanvasAccess.Builders.CreateDiscussionTopicBuilder.WithRequiredInitialPost ( bool require = true )

inline

If enabled, users cannot reply to other replies until they themselves have posted a reply.

Parameters

require

Returns

◆ WithScheduledLock()

CreateDiscussionTopicBuilder UVACanvasAccess.Builders.CreateDiscussionTopicBuilder.WithScheduledLock ( DateTime lockAt )

inline

If set, the topic will lock itself at this time.

Parameters

lockAt

Returns

◆ WithSortingByRating()

CreateDiscussionTopicBuilder UVACanvasAccess.Builders.CreateDiscussionTopicBuilder.WithSortingByRating ( bool sortByRating = true )

inline

If set, entries will be sorted by rating.

Parameters

sortByRating

Returns

◆ WithSpecificSections()

CreateDiscussionTopicBuilder UVACanvasAccess.Builders.CreateDiscussionTopicBuilder.WithSpecificSections ( IEnumerable< ulong > sections )

inline

If this topic is an announcement, lives in a course, and this is set, the topic will only appear to these specific sections.

Parameters

sections

Returns

◆ WithTitle()

CreateDiscussionTopicBuilder UVACanvasAccess.Builders.CreateDiscussionTopicBuilder.WithTitle ( string title )

inline

The title.

Parameters

title

Returns

The documentation for this class was generated from the following file:

UVACanvasAccess/Builders/CreateDiscussionTopicBuilder.cs

Public Member Functions

Detailed Description

Member Function Documentation

◆ AsAnnouncement()

◆ AsPinned()

◆ Post()

◆ WithAssignment()

◆ WithAttachment()

◆ WithDelayedPosting()

◆ WithDiscussionType()

◆ WithGraderRatingsOnly()

◆ WithGroupCategory()

◆ WithMessage()

◆ WithPodcastEnabled()

◆ WithPodcastIncludingStudents()

◆ WithPositionAfter()

◆ WithPublishedStatus()

◆ WithRatingsAllowed()

◆ WithRequiredInitialPost()

◆ WithScheduledLock()

◆ WithSortingByRating()

◆ WithSpecificSections()

◆ WithTitle()