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

Inheritance diagram for MixERP.Net.Api.Localization.LocalizedResourceController:

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

long	Count ()
	Counts the number of localized resources. More...

IEnumerable< MixERP.Net.Entities.Localization.LocalizedResource >	Get ()
	Returns collection of localized resource for export. More...

MixERP.Net.Entities.Localization.LocalizedResource	Get (long localizedResourceId)
	Returns an instance of localized resource. More...

IEnumerable< MixERP.Net.Entities.Localization.LocalizedResource >	Get ([FromUri] long[] localizedResourceIds)

IEnumerable< MixERP.Net.Entities.Localization.LocalizedResource >	GetPagedResult ()
	Creates a paginated collection containing 25 localized resources on each page, sorted by the property LocalizedResourceId. More...

IEnumerable< MixERP.Net.Entities.Localization.LocalizedResource >	GetPagedResult (long pageNumber)
	Creates a paginated collection containing 25 localized resources on each page, sorted by the property LocalizedResourceId. More...

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

IEnumerable< MixERP.Net.Entities.Localization.LocalizedResource >	GetWhere (long pageNumber, [FromBody]dynamic filters)
	Creates a filtered and paginated collection containing 25 localized resources on each page, sorted by the property LocalizedResourceId. More...

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

IEnumerable< MixERP.Net.Entities.Localization.LocalizedResource >	GetFiltered (long pageNumber, string filterName)
	Creates a filtered and paginated collection containing 25 localized resources on each page, sorted by the property LocalizedResourceId. More...

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

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

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

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

void	Add (MixERP.Net.Entities.Localization.LocalizedResource localizedResource)
	Adds your instance of LocalizedResource class. More...

void	Edit (long localizedResourceId, [FromBody] MixERP.Net.Entities.Localization.LocalizedResource localizedResource)
	Edits existing record with your instance of LocalizedResource class. More...

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

void	Delete (long localizedResourceId)
	Deletes an existing instance of LocalizedResource class via LocalizedResourceId. 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 Localized Resources.

Member Function Documentation

void MixERP.Net.Api.Localization.LocalizedResourceController.Add ( MixERP.Net.Entities.Localization.LocalizedResource localizedResource )

Adds your instance of LocalizedResource class.

Parameters

localizedResource Your instance of localized resources class to add.

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

Adds or edits your instance of LocalizedResource class.

Parameters

localizedResource Your instance of localized resources class to add or edit.

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

Adds or edits multiple instances of LocalizedResource class.

Parameters

collection Your collection of LocalizedResource class to bulk import.

Returns: Returns list of imported localizedResourceIds.

Exceptions

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

long MixERP.Net.Api.Localization.LocalizedResourceController.Count ( )

Counts the number of localized resources.

Returns: Returns the count of the localized resources.

long MixERP.Net.Api.Localization.LocalizedResourceController.CountFiltered ( string filterName )

Counts the number of localized resources using the supplied filter name.

Parameters

filterName The named filter.

Returns: Returns the count of filtered localized resources.

long MixERP.Net.Api.Localization.LocalizedResourceController.CountWhere ( [FromBody] dynamic filters )

Counts the number of localized resources using the supplied filter(s).

Parameters

filters The list of filter conditions.

Returns: Returns the count of filtered localized resources.

void MixERP.Net.Api.Localization.LocalizedResourceController.Delete ( long localizedResourceId )

Deletes an existing instance of LocalizedResource class via LocalizedResourceId.

Parameters

localizedResourceId Enter the value for LocalizedResourceId in order to find and delete the existing record.

void MixERP.Net.Api.Localization.LocalizedResourceController.Edit	(	long	localizedResourceId,
		[FromBody] MixERP.Net.Entities.Localization.LocalizedResource	localizedResource
	)

Edits existing record with your instance of LocalizedResource class.

Parameters

localizedResource	Your instance of LocalizedResource class to edit.
localizedResourceId	Enter the value for LocalizedResourceId in order to find and edit the existing record.

IEnumerable<MixERP.Net.Entities.Localization.LocalizedResource> MixERP.Net.Api.Localization.LocalizedResourceController.Get ( )

Returns collection of localized resource for export.

Returns

MixERP.Net.Entities.Localization.LocalizedResource MixERP.Net.Api.Localization.LocalizedResourceController.Get ( long localizedResourceId )

Returns an instance of localized resource.

Parameters

localizedResourceId Enter LocalizedResourceId to search for.

Returns

IEnumerable<PetaPoco.CustomField> MixERP.Net.Api.Localization.LocalizedResourceController.GetCustomFields ( )

A custom field is a user defined field for localized resources.

Returns: Returns an enumerable custom field collection of localized resources.

IEnumerable<PetaPoco.CustomField> MixERP.Net.Api.Localization.LocalizedResourceController.GetCustomFields ( string resourceId )

A custom field is a user defined field for localized resources.

Returns: Returns an enumerable custom field collection of localized resources.

IEnumerable<DisplayField> MixERP.Net.Api.Localization.LocalizedResourceController.GetDisplayFields ( )

Displayfield is a lightweight key/value collection of localized resources.

Returns: Returns an enumerable key/value collection of localized resources.

EntityView MixERP.Net.Api.Localization.LocalizedResourceController.GetEntityView ( )

Creates meta information of "localized resource" entity.

Returns: Returns the "localized resource" meta information to perform CRUD operation.

IEnumerable<MixERP.Net.Entities.Localization.LocalizedResource> MixERP.Net.Api.Localization.LocalizedResourceController.GetFiltered	(	long	pageNumber,
		string	filterName
	)

Creates a filtered and paginated collection containing 25 localized resources on each page, sorted by the property LocalizedResourceId.

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.Localization.LocalizedResource> MixERP.Net.Api.Localization.LocalizedResourceController.GetPagedResult ( )

Creates a paginated collection containing 25 localized resources on each page, sorted by the property LocalizedResourceId.

Returns: Returns the first page from the collection.

IEnumerable<MixERP.Net.Entities.Localization.LocalizedResource> MixERP.Net.Api.Localization.LocalizedResourceController.GetPagedResult ( long pageNumber )

Creates a paginated collection containing 25 localized resources on each page, sorted by the property LocalizedResourceId.

Parameters

pageNumber Enter the page number to produce the resultset.

Returns: Returns the requested page from the collection.

IEnumerable<MixERP.Net.Entities.Localization.LocalizedResource> MixERP.Net.Api.Localization.LocalizedResourceController.GetWhere	(	long	pageNumber,
		[FromBody] dynamic	filters
	)

Creates a filtered and paginated collection containing 25 localized resources on each page, sorted by the property LocalizedResourceId.

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/Localization/LocalizedResourceController.cs

Public Member Functions

Properties

Detailed Description

Member Function Documentation