UVACanvasAccess
Loading...
Searching...
No Matches
Public Member Functions | Properties | List of all members
UVACanvasAccess.Structures.Discussions.DiscussionTopic Class Reference

Represents a discussion topic. More...

Inheritance diagram for UVACanvasAccess.Structures.Discussions.DiscussionTopic:
Inheritance graph
[legend]
Collaboration diagram for UVACanvasAccess.Structures.Discussions.DiscussionTopic:
Collaboration graph
[legend]

Public Member Functions

Task< IEnumerable< TopicEntry > > GetEntries ()
 Gets the list of entries for this topic.
 
string ToPrettyString ()
 Returns a pretty, formatted string representation of the object.
Returns
The formatted string.

 

Properties

DiscussionHome Home [get]
 Which type of entity the discussion belongs to.
 
ulong HomeId [get]
 The id of the entity the discussion belongs to.
 
ulong Id [get]
 The discussion id.
 
string Title [get]
 The discussion title.
 
string Message [get]
 The content of the discussion topic.
 
string HtmlUrl [get]
 The webpage url of the discussion topic.
 
DateTime? PostedAt [get]
 When the topic was posted.
 
DateTime? LastReplyAt [get]
 When the last reply was made to the topic.
 
bool? RequireInitialPost [get]
 Whether a user must first post a reply before being allowed to respond to other replies.
 
bool? UserCanSeePosts [get]
 Whether a user can see other replies.
 
uint? DiscussionSubentryCount [get]
 The amount of entries in the topic.
 
string ReadState [get]
 The read state of the topic for the current user.
 
uint? UnreadCount [get]
 The amount of unread entries in the topic for the current user.
 
bool? Subscribed [get]
 Whether the user is subscribed to the topic.
 
string SubscriptionHold [get]
 If the user is forbidden from subscribing to the topic, the reason.
 
ulong? AssignmentId [get]
 If this topic is for grading an assignment, the assignment id.
 
DateTime? DelayedPostAt [get]
 If the topic is set to be posted after a delay, when the topic will be posted.
 
bool? Published [get]
 Whether the topic is published.
 
DateTime? LockAt [get]
 When the topic will lock.
 
bool? Locked [get]
 Whether the topic is locked.
 
bool? Pinned [get]
 Whether the topic is pinned.
 
bool? LockedForUser [get]
 Whether the topic is locked for the current user.
 
object LockInfo [get]
 Present if the topic is locked for the current user.
 
string LockExplanation [get]
 If the topic is locked for the current user, the reason.
 
string UserName [get]
 The name of the topic creator.
 
IEnumerable< uint > TopicChildren [get]
 
object GroupTopicChildren [get]
 
ulong? RootTopicId [get]
 The root topic id, if a root topic exists.
 
string PodcastUrl [get]
 If the topic is a podcast, the podcast url.
 
DiscussionTypeDiscussionType [get]
 The discussion type, i. e. whether replies may themselves have nested replies.
 
ulong? GroupCategoryId [get]
 If this is a group discussion, the group category id.
 
IEnumerable< FileAttachmentAttachments [get]
 Any attachments to the discussion.
 
Dictionary< string, bool > Permissions [get]
 The current user's permissions for the discussion.
 
bool? AllowRating [get]
 Whether users can rate replies.
 
bool? OnlyGradersCanRate [get]
 Whether rating is restricted to graders.
 
bool? SortByRating [get]
 Whether replies should be sorted by rating.
 
UserDisplay Author [get, set]
 The author of the topic.
 

Detailed Description

Represents a discussion topic.

Member Function Documentation

◆ GetEntries()

Task< IEnumerable< TopicEntry > > UVACanvasAccess.Structures.Discussions.DiscussionTopic.GetEntries ( )
inline

Gets the list of entries for this topic.

Returns
The list of entries.

◆ ToPrettyString()

string UVACanvasAccess.Structures.Discussions.DiscussionTopic.ToPrettyString ( )
inline

Returns a pretty, formatted string representation of the object.

Returns
The formatted string.

Implements UVACanvasAccess.Util.IPrettyPrint.


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