UVACanvasAccess.Structures.Conversations.DetailedConversation Class Reference

Fully represents a conversation thread between 2 or more users. More...

Inheritance diagram for UVACanvasAccess.Structures.Conversations.DetailedConversation:

Collaboration diagram for UVACanvasAccess.Structures.Conversations.DetailedConversation:

Public Member Functions
override string	ToPrettyString ()
	Returns a pretty, formatted string representation of the object. Returns The formatted string.
override Task< DetailedConversation >	AsDetailedConversation ()
	Returns this conversation.
Public Member Functions inherited from UVACanvasAccess.Structures.Conversations.Conversation
Task< Conversation >	AddMessage (string body, IEnumerable< QualifiedId > specificRecipients=null, IEnumerable< ulong > includedMessages=null, IEnumerable< string > attachmentIds=null, string mediaCommentId=null, string mediaCommentType=null, bool? addJournalEntry=null)
	Adds a message to this conversation.

Properties
IEnumerable< ConversationMessage >	Messages [get]
	List of messages in the conversation.
Properties inherited from UVACanvasAccess.Structures.Conversations.Conversation
ulong	Id [get]
	The conversation id.
string	Subject [get]
	The conversation subject.
ConversationReadState	ReadState [get]
	The conversation's read state from the perspective of the current user.
string	LastMessage [get]
	The most recent message.
DateTime?	LastMessageAt [get]
	When the last message was sent.
uint	MessageCount [get]
	The message count.
bool?	Subscribed [get]
	Whether the current user is subscribed to the conversation.
bool?	Private [get]
	Whether the conversation is private.
bool?	Starred [get]
	Whether the conversation is starred.
ConversationFlags	Properties [get]
	Additional flags.
bool	CurrentUserIsLastAuthor [get]
	Whether the current user authored the most recent message in the conversation.
bool	HasAttachments [get]
	Whether the conversation has attachments.
bool	HasMediaObjects [get]
	Whether the conversation has media objects.
IEnumerable< ulong >	Audience [get]
	List of user ids involved in the conversation.
Dictionary< string, Dictionary< string, IEnumerable< string > > >	AudienceContexts [get]
	Shared contexts between the audience members.
string	AvatarUrl [get]
	The avatar url.
IEnumerable< ConversationParticipant >	Participants [get]
	List of participants.
bool?	Visible [get]
	Whether the conversation would be visible to the current user in the web UI.
string	ContextName [get]
	The context name (e.g. which course or group the conversation is occuring in).

Additional Inherited Members
Protected Attributes inherited from UVACanvasAccess.Structures.Conversations.Conversation
readonly Api	Api

Detailed Description

Fully represents a conversation thread between 2 or more users.

Member Function Documentation

AsDetailedConversation()

override Task< DetailedConversation > UVACanvasAccess.Structures.Conversations.DetailedConversation.AsDetailedConversation ( )

inlinesealedvirtual

Returns this conversation.

Returns

This.

Reimplemented from UVACanvasAccess.Structures.Conversations.Conversation.

ToPrettyString()

override string UVACanvasAccess.Structures.Conversations.DetailedConversation.ToPrettyString ( )

inlinevirtual

Returns a pretty, formatted string representation of the object.

Returns

The formatted string.

Reimplemented from UVACanvasAccess.Structures.Conversations.Conversation.

---

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

• UVACanvasAccess/Structures/Conversations/DetailedConversation.cs