UVACanvasAccess
Public Member Functions | Protected Member Functions | Properties | List of all members
UVACanvasAccess.Structures.ContentShares.ContentShare Class Referenceabstract

Represents a content share between a sender and one or more receivers. More...

Inheritance diagram for UVACanvasAccess.Structures.ContentShares.ContentShare:
Inheritance graph
[legend]
Collaboration diagram for UVACanvasAccess.Structures.ContentShares.ContentShare:
Collaboration graph
[legend]

Public Member Functions

abstract string ToPrettyString ()
 Returns a pretty, formatted string representation of the object. More...
 

Protected Member Functions

 ContentShare (Api api, ContentShareModel model)
 

Properties

ulong Id [get]
 The id of the share (for the current user). More...
 
string Name [get]
 The name of the shared content. More...
 
ContentShareType ContentType [get]
 The type of the shared content. More...
 
DateTime CreatedAt [get]
 When the content was initially shared. More...
 
DateTime? UpdatedAt [get]
 When the content was last updated. More...
 
ulong? UserId [get]
 The id of the user who sent or received the content, i.e., the subject of the api call which returned this object. More...
 
ulong? CourseId [get]
 The id of the course this content was originally shared from. More...
 
bool ReadState [get]
 Whether or not the recipient has viewed the share. More...
 
ulong? ContentExportId [get]
 The content export id associated with this share. More...
 

Detailed Description

Represents a content share between a sender and one or more receivers.

Member Function Documentation

◆ ToPrettyString()

abstract string UVACanvasAccess.Structures.ContentShares.ContentShare.ToPrettyString ( )
pure virtual

Returns a pretty, formatted string representation of the object.

Returns
The formatted string.

Implements UVACanvasAccess.Util.IPrettyPrint.

Implemented in UVACanvasAccess.Structures.ContentShares.ContentShareWithReceivers, and UVACanvasAccess.Structures.ContentShares.ContentShareWithSender.

Property Documentation

◆ ContentExportId

ulong? UVACanvasAccess.Structures.ContentShares.ContentShare.ContentExportId
get

The content export id associated with this share.

◆ ContentType

ContentShareType UVACanvasAccess.Structures.ContentShares.ContentShare.ContentType
get

The type of the shared content.

◆ CourseId

ulong? UVACanvasAccess.Structures.ContentShares.ContentShare.CourseId
get

The id of the course this content was originally shared from.

◆ CreatedAt

DateTime UVACanvasAccess.Structures.ContentShares.ContentShare.CreatedAt
get

When the content was initially shared.

◆ Id

ulong UVACanvasAccess.Structures.ContentShares.ContentShare.Id
get

The id of the share (for the current user).

◆ Name

string UVACanvasAccess.Structures.ContentShares.ContentShare.Name
get

The name of the shared content.

◆ ReadState

bool UVACanvasAccess.Structures.ContentShares.ContentShare.ReadState
get

Whether or not the recipient has viewed the share.

◆ UpdatedAt

DateTime? UVACanvasAccess.Structures.ContentShares.ContentShare.UpdatedAt
get

When the content was last updated.

◆ UserId

ulong? UVACanvasAccess.Structures.ContentShares.ContentShare.UserId
get

The id of the user who sent or received the content, i.e., the subject of the api call which returned this object.


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