Represents a record of a user page view request. More...

Inheritance diagram for UVACanvasAccess.Structures.Users.PageView:

Collaboration diagram for UVACanvasAccess.Structures.Users.PageView:

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

Properties
string	Id `[get]`
	The view's UUID. More...

string	AppName `[get]`
	If this was an API request, the name of the app that generated the access token. More...

string	Url `[get]`
	The requested URL. More...

string	ContextType `[get]`
	The context for this request. I.e., what part of the API this request is being made on. More...

string	AssetType `[get]`
	The asset within the ContextType this request is being made on, if relevant. More...

string	Controller `[get]`
	The Rails controller that handled this request. More...

string	Action `[get]`
	The Rails action that handled this request. More...

decimal?	InteractionSeconds `[get]`
	An approximation of how long the user spent on the page, in seconds. More...

DateTime	CreatedAt `[get]`
	When this request was made. More...

bool?	UserRequest `[get]`
	Whether or not this request was initiated by a real user. More...

double?	RenderTime `[get]`
	An approximation of how long the page took to render, in seconds. More...

string	UserAgent `[get]`
	The user agent of the browser or program that made this request. More...

bool?	Participated `[get]`
	Whether or not this interaction counted as participation. More...

string	HttpMethod `[get]`
	The HTTP method of this request. More...

string	RemoteIp `[get]`
	The origin IP address of this request. More...

PageViewLinks	Links `[get]`
	Relationships to this view. More...

Detailed Description

Represents a record of a user page view request.

Member Function Documentation

◆ ToPrettyString()

string UVACanvasAccess.Structures.Users.PageView.ToPrettyString ( )

inline

Returns a pretty, formatted string representation of the object.

Returns: The formatted string.

Implements UVACanvasAccess.Util.IPrettyPrint.

Property Documentation

◆ Action

string UVACanvasAccess.Structures.Users.PageView.Action

get

The Rails action that handled this request.

◆ AppName

string UVACanvasAccess.Structures.Users.PageView.AppName

get

If this was an API request, the name of the app that generated the access token.

◆ AssetType

string UVACanvasAccess.Structures.Users.PageView.AssetType

get

The asset within the ContextType this request is being made on, if relevant.

◆ ContextType

string UVACanvasAccess.Structures.Users.PageView.ContextType

get

The context for this request. I.e., what part of the API this request is being made on.

◆ Controller

string UVACanvasAccess.Structures.Users.PageView.Controller

get

The Rails controller that handled this request.

◆ CreatedAt

DateTime UVACanvasAccess.Structures.Users.PageView.CreatedAt

get

When this request was made.

◆ HttpMethod

string UVACanvasAccess.Structures.Users.PageView.HttpMethod

get

The HTTP method of this request.

◆ Id

string UVACanvasAccess.Structures.Users.PageView.Id

get

The view's UUID.

◆ InteractionSeconds

decimal? UVACanvasAccess.Structures.Users.PageView.InteractionSeconds

get

An approximation of how long the user spent on the page, in seconds.

◆ Links

PageViewLinks UVACanvasAccess.Structures.Users.PageView.Links

get

Relationships to this view.

◆ Participated

bool? UVACanvasAccess.Structures.Users.PageView.Participated

get

Whether or not this interaction counted as participation.

◆ RemoteIp

string UVACanvasAccess.Structures.Users.PageView.RemoteIp

get

The origin IP address of this request.

◆ RenderTime

double? UVACanvasAccess.Structures.Users.PageView.RenderTime

get

An approximation of how long the page took to render, in seconds.

◆ Url

string UVACanvasAccess.Structures.Users.PageView.Url

get

The requested URL.

◆ UserAgent

string UVACanvasAccess.Structures.Users.PageView.UserAgent

get

The user agent of the browser or program that made this request.

◆ UserRequest

bool? UVACanvasAccess.Structures.Users.PageView.UserRequest

get

Whether or not this request was initiated by a real user.

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

UVACanvasAccess/Structures/Users/PageView.cs

Public Member Functions

Properties