Summarizes a conversation thread between 2 or more users. More...

Inheritance diagram for UVACanvasAccess.Structures.Conversations.Conversation:

[legend]

Collaboration diagram for UVACanvasAccess.Structures.Conversations.Conversation:

[legend]

Public Member Functions
virtual string	ToPrettyString ()
	Returns a pretty, formatted string representation of the object. Returns The formatted string.

virtual Task< DetailedConversation >	AsDetailedConversation ()
	Converts this conversation to a DetailedConversation with full message history.

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.

Protected Attributes
readonly Api	Api

Properties
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).

Detailed Description

Summarizes a conversation thread between 2 or more users.

See also: DetailedConversation

Member Function Documentation

◆ AddMessage()

Task< Conversation > UVACanvasAccess.Structures.Conversations.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`
	)

inline

Adds a message to this conversation.

Parameters

body	The message to send.
specificRecipients	(Optional) Specific recipients to send the message to.
includedMessages	(Optional) The set of past messages to send to recipients not already present in the conversation.
attachmentIds	(Optional) Attachment ids. Attachments must have been uploaded to the current user's attachments folder.
mediaCommentId	(Optional) Media comment id.
mediaCommentType	(Optional) Media comment type.
addJournalEntry	(Optional) If true, a faculty journal entry will be created to record this conversation.

Returns: The updated conversation.

◆ AsDetailedConversation()

virtual Task< DetailedConversation > UVACanvasAccess.Structures.Conversations.Conversation.AsDetailedConversation ( )

inlinevirtual

Converts this conversation to a DetailedConversation with full message history.

Returns: The DetailedConversation summarized by this conversation.

See also: UVACanvasAccess.ApiParts.Api.GetConversation

Reimplemented in UVACanvasAccess.Structures.Conversations.DetailedConversation.

◆ ToPrettyString()

virtual string UVACanvasAccess.Structures.Conversations.Conversation.ToPrettyString ( )

inlinevirtual

Returns a pretty, formatted string representation of the object.

Returns: The formatted string.

Implements UVACanvasAccess.Util.IPrettyPrint.

Reimplemented in UVACanvasAccess.Structures.Conversations.DetailedConversation.

Property Documentation

◆ Properties

ConversationFlags UVACanvasAccess.Structures.Conversations.Conversation.Properties

get

Additional flags.

See also: CurrentUserIsLastAuthor, HasAttachments, HasMediaObjects

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

UVACanvasAccess/Structures/Conversations/Conversation.cs

Public Member Functions

Protected Attributes