Represents a discussion topic. More...
Inheritance diagram for UVACanvasAccess.Structures.Discussions.DiscussionTopic:
Collaboration diagram for UVACanvasAccess.Structures.Discussions.DiscussionTopic:
Public Member Functions | |
| Task< IEnumerable< TopicEntry > > | GetEntries () |
| Gets the list of entries for this topic. More... | |
| string | ToPrettyString () |
| Returns a pretty, formatted string representation of the object. | |
Properties | |
| DiscussionHome | Home [get] |
| Which type of entity the discussion belongs to. More... | |
| ulong | HomeId [get] |
| The id of the entity the discussion belongs to. More... | |
| ulong | Id [get] |
| The discussion id. More... | |
| string | Title [get] |
| The discussion title. More... | |
| string | Message [get] |
| The content of the discussion topic. More... | |
| string | HtmlUrl [get] |
| The webpage url of the discussion topic. More... | |
| DateTime? | PostedAt [get] |
| When the topic was posted. More... | |
| DateTime? | LastReplyAt [get] |
| When the last reply was made to the topic. More... | |
| bool? | RequireInitialPost [get] |
| Whether a user must first post a reply before being allowed to respond to other replies. More... | |
| bool? | UserCanSeePosts [get] |
| Whether a user can see other replies. More... | |
| uint? | DiscussionSubentryCount [get] |
| The amount of entries in the topic. More... | |
| string | ReadState [get] |
| The read state of the topic for the current user. More... | |
| uint? | UnreadCount [get] |
| The amount of unread entries in the topic for the current user. More... | |
| bool? | Subscribed [get] |
| Whether the user is subscribed to the topic. More... | |
| string | SubscriptionHold [get] |
| If the user is forbidden from subscribing to the topic, the reason. More... | |
| ulong? | AssignmentId [get] |
| If this topic is for grading an assignment, the assignment id. More... | |
| DateTime? | DelayedPostAt [get] |
| If the topic is set to be posted after a delay, when the topic will be posted. More... | |
| bool? | Published [get] |
| Whether the topic is published. More... | |
| DateTime? | LockAt [get] |
| When the topic will lock. More... | |
| bool? | Locked [get] |
| Whether the topic is locked. More... | |
| bool? | Pinned [get] |
| Whether the topic is pinned. More... | |
| bool? | LockedForUser [get] |
| Whether the topic is locked for the current user. More... | |
| object | LockInfo [get] |
| Present if the topic is locked for the current user. More... | |
| string | LockExplanation [get] |
| If the topic is locked for the current user, the reason. More... | |
| string | UserName [get] |
| The name of the topic creator. More... | |
| IEnumerable< uint > | TopicChildren [get] |
| object | GroupTopicChildren [get] |
| ulong? | RootTopicId [get] |
| The root topic id, if a root topic exists. More... | |
| string | PodcastUrl [get] |
| If the topic is a podcast, the podcast url. More... | |
| DiscussionType? | DiscussionType [get] |
| The discussion type, i. e. whether replies may themselves have nested replies. More... | |
| ulong? | GroupCategoryId [get] |
| If this is a group discussion, the group category id. More... | |
| IEnumerable< FileAttachment > | Attachments [get] |
| Any attachments to the discussion. More... | |
| Dictionary< string, bool > | Permissions [get] |
| The current user's permissions for the discussion. More... | |
| bool? | AllowRating [get] |
| Whether users can rate replies. More... | |
| bool? | OnlyGradersCanRate [get] |
| Whether rating is restricted to graders. More... | |
| bool? | SortByRating [get] |
| Whether replies should be sorted by rating. More... | |
| UserDisplay | Author [get, set] |
| The author of the topic. More... | |
Detailed Description
Represents a discussion topic.
Member Function Documentation
◆ GetEntries()
|
inline |
Gets the list of entries for this topic.
- Returns
- The list of entries.
Property Documentation
◆ AllowRating
|
get |
Whether users can rate replies.
◆ AssignmentId
|
get |
If this topic is for grading an assignment, the assignment id.
◆ Attachments
|
get |
Any attachments to the discussion.
◆ Author
|
getset |
The author of the topic.
◆ DelayedPostAt
|
get |
If the topic is set to be posted after a delay, when the topic will be posted.
◆ DiscussionSubentryCount
|
get |
The amount of entries in the topic.
◆ DiscussionType
|
get |
The discussion type, i. e. whether replies may themselves have nested replies.
◆ GroupCategoryId
|
get |
If this is a group discussion, the group category id.
◆ Home
|
get |
Which type of entity the discussion belongs to.
◆ HomeId
|
get |
The id of the entity the discussion belongs to.
◆ HtmlUrl
|
get |
The webpage url of the discussion topic.
◆ Id
|
get |
The discussion id.
◆ LastReplyAt
|
get |
When the last reply was made to the topic.
◆ LockAt
|
get |
When the topic will lock.
◆ Locked
|
get |
Whether the topic is locked.
◆ LockedForUser
|
get |
Whether the topic is locked for the current user.
◆ LockExplanation
|
get |
If the topic is locked for the current user, the reason.
◆ LockInfo
|
get |
Present if the topic is locked for the current user.
◆ Message
|
get |
The content of the discussion topic.
◆ OnlyGradersCanRate
|
get |
Whether rating is restricted to graders.
◆ Permissions
|
get |
The current user's permissions for the discussion.
◆ Pinned
|
get |
Whether the topic is pinned.
◆ PodcastUrl
|
get |
If the topic is a podcast, the podcast url.
◆ PostedAt
|
get |
When the topic was posted.
◆ Published
|
get |
Whether the topic is published.
◆ ReadState
|
get |
The read state of the topic for the current user.
◆ RequireInitialPost
|
get |
Whether a user must first post a reply before being allowed to respond to other replies.
◆ RootTopicId
|
get |
The root topic id, if a root topic exists.
◆ SortByRating
|
get |
Whether replies should be sorted by rating.
◆ Subscribed
|
get |
Whether the user is subscribed to the topic.
◆ SubscriptionHold
|
get |
If the user is forbidden from subscribing to the topic, the reason.
◆ Title
|
get |
The discussion title.
◆ UnreadCount
|
get |
The amount of unread entries in the topic for the current user.
◆ UserCanSeePosts
|
get |
Whether a user can see other replies.
◆ UserName
|
get |
The name of the topic creator.
The documentation for this class was generated from the following file:
- UVACanvasAccess/Structures/Discussions/DiscussionTopic.cs
