ViewController<T> Class

The base REST API for performing view tasks.

Inheritance Hierarchy

System.Object
  Microsoft.AspNetCore.Mvc.ControllerBase
    Dundas.BI.WebApi.Controllers.ApiControllerBase
      Dundas.BI.WebApi.Controllers.ViewController<T>
        Dundas.BI.WebApi.Controllers.DashboardController
        Dundas.BI.WebApi.Controllers.ReportController
        Dundas.BI.WebApi.Controllers.ScorecardController
        Dundas.BI.WebApi.Controllers.SmallMultipleController

Namespace: Dundas.BI.WebApi.Controllers
Assembly: Dundas.BI.WebApi (in Dundas.BI.WebApi.dll) Version: 2.0.0.0 (25.1.0.1000)

Syntax

C++

Copy

public abstract class ViewController<T> : ApiControllerBase
where T : new(), View

Public MustInherit Class ViewController(Of T As {New, View})
	Inherits ApiControllerBase

generic<typename T>
where T : gcnew(), View
public ref class ViewController abstract : public ApiControllerBase

[<AbstractClassAttribute>]
type ViewController<'T when 'T : new() and View> =  
    class
        inherit ApiControllerBase
    end

Type Parameters

T: The specific view type.

The ViewController<T> type exposes the following members.

Constructors

	Name	Description
	ViewController<T>	Initializes a new instance of the ViewController<T> class

Top

Properties

	Name	Description
	ViewService	Gets the service that provides functionality for getting and saving views.

Top

Methods

	Name	Description
	CodeLibraryRecursiveReferenceIds	Recursively gets the code library reference IDs in the reverse order as a flat list so that they can be included in script includes on a web page. See GetCodeLibraryRecursiveReferenceIds() for more information on the methodology.
	Create	Creates a view.
	CreateLocalUserCopy	Creates a local user copy of a view and any metric sets which are not sub entries.
	EnsureCallerContext	If the current context is not already the specified context, creates a new caller context which is a clone of the specified context and sets it as the current one. (Inherited from ApiControllerBase.)
	EnsureFormFileMultipartContent	Ensures when form files are access the content is MIME multi-part which we want. (Inherited from ApiControllerBase.)
	GenerateAndStoreViewThumbnail	Queues an asynchronous operation to generate a thumbnail for the specified view and store it in the application database.
	GetById	Retrieves a view.
	GetByIds	Retrieves multiple views.
	GetByIds2	Retrieves multiple views with options.
	GetClientIdFromCookieOrProvided	Gets the client ID from cookie or from the provided value, which is usually from the query string. (Inherited from ApiControllerBase.)
	GetService<T>	Gets the requested service. (Inherited from ApiControllerBase.)
	GetSessionIdFromCookieHeaderOrProvided	Gets the session ID from cookie, the authorization header or from the provided value, which is usually from the query string. (Inherited from ApiControllerBase.)
	LoadSession	Creates a new caller context associated with the specified session ID. The session is not validated. (Inherited from ApiControllerBase.)
	RequestFirstFormFile	Retrieves the first form file from the request. (Inherited from ApiControllerBase.)
	RequestFormFiles	Retrieves the form files from the request. (Inherited from ApiControllerBase.)
	ReturnInvalidWindowsIdentityResponse	Returns the invalid windows identity response to challenge the browser. (Inherited from ApiControllerBase.)
	TrackUsage	Tracks the usage for the view provided. If the session and client ID are not provided, the current cookie values are used.
	TrackUsages	Tracks the usages for the views provided. If the session and client ID are not provided, the current cookie values are used.
	Update	Updates view.

Top

Reference

Dundas.BI.WebApi.Controllers Namespace

ViewController<AddLanguageSpecificTextSet("LSTEAFB27D7_0?cs=&lt;|vb=(Of |cpp=&lt;|fs=&lt;'|nu=(");T>AddLanguageSpecificTextSet("LSTEAFB27D7_1?cs=&gt;|vb=)|cpp=&gt;|fs=&gt;|nu=)"); Class

Type Parameters

Reference

ViewController<T> Class