Provides a direct HTTP access to perform various tasks such as adding, editing, and removing Widgets. More...

Inheritance diagram for MixERP.Net.Api.Core.WidgetController:

Public Member Functions
EntityView	GetEntityView ()
	Creates meta information of "widget" entity. More...

long	Count ()
	Counts the number of widgets. More...

IEnumerable< MixERP.Net.Entities.Core.Widget >	Get ()
	Returns collection of widget for export. More...

MixERP.Net.Entities.Core.Widget	Get (string widgetName)
	Returns an instance of widget. More...

IEnumerable< MixERP.Net.Entities.Core.Widget >	Get ([FromUri] string[] widgetNames)

IEnumerable< MixERP.Net.Entities.Core.Widget >	GetPagedResult ()
	Creates a paginated collection containing 25 widgets on each page, sorted by the property WidgetName. More...

IEnumerable< MixERP.Net.Entities.Core.Widget >	GetPagedResult (long pageNumber)
	Creates a paginated collection containing 25 widgets on each page, sorted by the property WidgetName. More...

long	CountWhere ([FromBody]dynamic filters)
	Counts the number of widgets using the supplied filter(s). More...

IEnumerable< MixERP.Net.Entities.Core.Widget >	GetWhere (long pageNumber, [FromBody]dynamic filters)
	Creates a filtered and paginated collection containing 25 widgets on each page, sorted by the property WidgetName. More...

long	CountFiltered (string filterName)
	Counts the number of widgets using the supplied filter name. More...

IEnumerable< MixERP.Net.Entities.Core.Widget >	GetFiltered (long pageNumber, string filterName)
	Creates a filtered and paginated collection containing 25 widgets on each page, sorted by the property WidgetName. More...

IEnumerable< DisplayField >	GetDisplayFields ()
	Displayfield is a lightweight key/value collection of widgets. More...

IEnumerable< PetaPoco.CustomField >	GetCustomFields ()
	A custom field is a user defined field for widgets. More...

IEnumerable< PetaPoco.CustomField >	GetCustomFields (string resourceId)
	A custom field is a user defined field for widgets. More...

void	AddOrEdit ([FromBody]Newtonsoft.Json.Linq.JArray form)
	Adds or edits your instance of Widget class. More...

void	Add (MixERP.Net.Entities.Core.Widget widget)
	Adds your instance of Widget class. More...

void	Edit (string widgetName, [FromBody] MixERP.Net.Entities.Core.Widget widget)
	Edits existing record with your instance of Widget class. More...

List< object >	BulkImport ([FromBody]dynamic collection)
	Adds or edits multiple instances of Widget class. More...

void	Delete (string widgetName)
	Deletes an existing instance of Widget class via WidgetName. More...

Properties
long	LoginId `[get]`

int	UserId `[get]`

int	OfficeId `[get]`

string	Catalog `[get]`

Detailed Description

Provides a direct HTTP access to perform various tasks such as adding, editing, and removing Widgets.

Member Function Documentation

void MixERP.Net.Api.Core.WidgetController.Add ( MixERP.Net.Entities.Core.Widget widget )

Adds your instance of Widget class.

Parameters

widget Your instance of widgets class to add.

void MixERP.Net.Api.Core.WidgetController.AddOrEdit ( [FromBody] Newtonsoft.Json.Linq.JArray form )

Adds or edits your instance of Widget class.

Parameters

widget Your instance of widgets class to add or edit.

List<object> MixERP.Net.Api.Core.WidgetController.BulkImport ( [FromBody] dynamic collection )

Adds or edits multiple instances of Widget class.

Parameters

collection Your collection of Widget class to bulk import.

Returns: Returns list of imported widgetNames.

Exceptions

MixERPException Thrown when your any Widget class in the collection is invalid or malformed.

long MixERP.Net.Api.Core.WidgetController.Count ( )

Counts the number of widgets.

Returns: Returns the count of the widgets.

long MixERP.Net.Api.Core.WidgetController.CountFiltered ( string filterName )

Counts the number of widgets using the supplied filter name.

Parameters

filterName The named filter.

Returns: Returns the count of filtered widgets.

long MixERP.Net.Api.Core.WidgetController.CountWhere ( [FromBody] dynamic filters )

Counts the number of widgets using the supplied filter(s).

Parameters

filters The list of filter conditions.

Returns: Returns the count of filtered widgets.

void MixERP.Net.Api.Core.WidgetController.Delete ( string widgetName )

Deletes an existing instance of Widget class via WidgetName.

Parameters

widgetName Enter the value for WidgetName in order to find and delete the existing record.

void MixERP.Net.Api.Core.WidgetController.Edit	(	string	widgetName,
		[FromBody] MixERP.Net.Entities.Core.Widget	widget
	)

Edits existing record with your instance of Widget class.

Parameters

widget	Your instance of Widget class to edit.
widgetName	Enter the value for WidgetName in order to find and edit the existing record.

IEnumerable<MixERP.Net.Entities.Core.Widget> MixERP.Net.Api.Core.WidgetController.Get ( )

Returns collection of widget for export.

Returns

MixERP.Net.Entities.Core.Widget MixERP.Net.Api.Core.WidgetController.Get ( string widgetName )

Returns an instance of widget.

Parameters

widgetName Enter WidgetName to search for.

Returns

IEnumerable<PetaPoco.CustomField> MixERP.Net.Api.Core.WidgetController.GetCustomFields ( )

A custom field is a user defined field for widgets.

Returns: Returns an enumerable custom field collection of widgets.

IEnumerable<PetaPoco.CustomField> MixERP.Net.Api.Core.WidgetController.GetCustomFields ( string resourceId )

A custom field is a user defined field for widgets.

Returns: Returns an enumerable custom field collection of widgets.

IEnumerable<DisplayField> MixERP.Net.Api.Core.WidgetController.GetDisplayFields ( )

Displayfield is a lightweight key/value collection of widgets.

Returns: Returns an enumerable key/value collection of widgets.

EntityView MixERP.Net.Api.Core.WidgetController.GetEntityView ( )

Creates meta information of "widget" entity.

Returns: Returns the "widget" meta information to perform CRUD operation.

IEnumerable<MixERP.Net.Entities.Core.Widget> MixERP.Net.Api.Core.WidgetController.GetFiltered	(	long	pageNumber,
		string	filterName
	)

Creates a filtered and paginated collection containing 25 widgets on each page, sorted by the property WidgetName.

Parameters

pageNumber	Enter the page number to produce the resultset.
filterName	The named filter.

Returns: Returns the requested page from the collection using the supplied filters.

IEnumerable<MixERP.Net.Entities.Core.Widget> MixERP.Net.Api.Core.WidgetController.GetPagedResult ( )

Creates a paginated collection containing 25 widgets on each page, sorted by the property WidgetName.

Returns: Returns the first page from the collection.

IEnumerable<MixERP.Net.Entities.Core.Widget> MixERP.Net.Api.Core.WidgetController.GetPagedResult ( long pageNumber )

Creates a paginated collection containing 25 widgets on each page, sorted by the property WidgetName.

Parameters

pageNumber Enter the page number to produce the resultset.

Returns: Returns the requested page from the collection.

IEnumerable<MixERP.Net.Entities.Core.Widget> MixERP.Net.Api.Core.WidgetController.GetWhere	(	long	pageNumber,
		[FromBody] dynamic	filters
	)

Creates a filtered and paginated collection containing 25 widgets on each page, sorted by the property WidgetName.

Parameters

pageNumber	Enter the page number to produce the resultset.
filters	The list of filter conditions.

Returns: Returns the requested page from the collection using the supplied filters.

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

C:/Users/nirvan/Desktop/mixerp/0. GitHub/src/Libraries/Web API/Core/WidgetController.cs

Public Member Functions

Properties

Detailed Description

Member Function Documentation