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

Inheritance diagram for UVACanvasAccess.Structures.Conversations.Conversation:

Collaboration diagram for UVACanvasAccess.Structures.Conversations.Conversation:

[legend]

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

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

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. More...

Protected Attributes
readonly Api	Api

Properties
ulong	Id `[get]`
	The conversation id. More...

string	Subject `[get]`
	The conversation subject. More...

ConversationReadState	ReadState `[get]`
	The conversation's read state from the perspective of the current user. More...

string	LastMessage `[get]`
	The most recent message. More...

DateTime?	LastMessageAt `[get]`
	When the last message was sent. More...

uint	MessageCount `[get]`
	The message count. More...

bool?	Subscribed `[get]`
	Whether the current user is subscribed to the conversation. More...

bool?	Private `[get]`
	Whether the conversation is private. More...

bool?	Starred `[get]`
	Whether the conversation is starred. More...

ConversationFlags	Properties `[get]`
	Additional flags. More...

bool	CurrentUserIsLastAuthor `[get]`
	Whether the current user authored the most recent message in the conversation. More...

bool	HasAttachments `[get]`
	Whether the conversation has attachments. More...

bool	HasMediaObjects `[get]`
	Whether the conversation has media objects. More...

IEnumerable< ulong >	Audience `[get]`
	List of user ids involved in the conversation. More...

Dictionary< string, Dictionary< string, IEnumerable< string > > >	AudienceContexts `[get]`
	Shared contexts between the audience members. More...

string	AvatarUrl `[get]`
	The avatar url. More...

IEnumerable< ConversationParticipant >	Participants `[get]`
	List of participants. More...

bool?	Visible `[get]`
	Whether the conversation would be visible to the current user in the web UI. More...

string	ContextName `[get]`
	The context name (e.g. which course or group the conversation is occuring in). More...

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.

Property Documentation

◆ Audience

IEnumerable<ulong> UVACanvasAccess.Structures.Conversations.Conversation.Audience

get

List of user ids involved in the conversation.

◆ AudienceContexts

Dictionary<string, Dictionary<string, IEnumerable<string> > > UVACanvasAccess.Structures.Conversations.Conversation.AudienceContexts

get

Shared contexts between the audience members.

◆ AvatarUrl

string UVACanvasAccess.Structures.Conversations.Conversation.AvatarUrl

get

The avatar url.

◆ ContextName

string UVACanvasAccess.Structures.Conversations.Conversation.ContextName

get

The context name (e.g. which course or group the conversation is occuring in).

◆ CurrentUserIsLastAuthor

bool UVACanvasAccess.Structures.Conversations.Conversation.CurrentUserIsLastAuthor

get

Whether the current user authored the most recent message in the conversation.

◆ HasAttachments

bool UVACanvasAccess.Structures.Conversations.Conversation.HasAttachments

get

Whether the conversation has attachments.

◆ HasMediaObjects

bool UVACanvasAccess.Structures.Conversations.Conversation.HasMediaObjects

get

Whether the conversation has media objects.

◆ Id

ulong UVACanvasAccess.Structures.Conversations.Conversation.Id

get

The conversation id.

◆ LastMessage

string UVACanvasAccess.Structures.Conversations.Conversation.LastMessage

get

The most recent message.

◆ LastMessageAt

DateTime? UVACanvasAccess.Structures.Conversations.Conversation.LastMessageAt

get

When the last message was sent.

◆ MessageCount

uint UVACanvasAccess.Structures.Conversations.Conversation.MessageCount

get

The message count.

◆ Participants

IEnumerable<ConversationParticipant> UVACanvasAccess.Structures.Conversations.Conversation.Participants

get

List of participants.

◆ Private

bool? UVACanvasAccess.Structures.Conversations.Conversation.Private

get

Whether the conversation is private.

◆ Properties

ConversationFlags UVACanvasAccess.Structures.Conversations.Conversation.Properties

get

Additional flags.

See also: CurrentUserIsLastAuthor, HasAttachments, HasMediaObjects

◆ ReadState

ConversationReadState UVACanvasAccess.Structures.Conversations.Conversation.ReadState

get

The conversation's read state from the perspective of the current user.

◆ Starred

bool? UVACanvasAccess.Structures.Conversations.Conversation.Starred

get

Whether the conversation is starred.

◆ Subject

string UVACanvasAccess.Structures.Conversations.Conversation.Subject

get

The conversation subject.

◆ Subscribed

bool? UVACanvasAccess.Structures.Conversations.Conversation.Subscribed

get

Whether the current user is subscribed to the conversation.

◆ Visible

bool? UVACanvasAccess.Structures.Conversations.Conversation.Visible

get

Whether the conversation would be visible to the current user in the web UI.

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

UVACanvasAccess/Structures/Conversations/Conversation.cs

Public Member Functions

Protected Attributes

Properties