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

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

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

long	Count ()
	Counts the number of email queues. More...

IEnumerable< MixERP.Net.Entities.Core.EmailQueue >	Get ()
	Returns collection of email queue for export. More...

MixERP.Net.Entities.Core.EmailQueue	Get (long queueId)
	Returns an instance of email queue. More...

IEnumerable< MixERP.Net.Entities.Core.EmailQueue >	Get ([FromUri] long[] queueIds)

IEnumerable< MixERP.Net.Entities.Core.EmailQueue >	GetPagedResult ()
	Creates a paginated collection containing 25 email queues on each page, sorted by the property QueueId. More...

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

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

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

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

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

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

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

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

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

void	Add (MixERP.Net.Entities.Core.EmailQueue emailQueue)
	Adds your instance of EmailQueue class. More...

void	Edit (long queueId, [FromBody] MixERP.Net.Entities.Core.EmailQueue emailQueue)
	Edits existing record with your instance of EmailQueue class. More...

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

void	Delete (long queueId)
	Deletes an existing instance of EmailQueue class via QueueId. 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 Email Queues.

Member Function Documentation

void MixERP.Net.Api.Core.EmailQueueController.Add ( MixERP.Net.Entities.Core.EmailQueue emailQueue )

Adds your instance of EmailQueue class.

Parameters

emailQueue Your instance of email queues class to add.

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

Adds or edits your instance of EmailQueue class.

Parameters

emailQueue Your instance of email queues class to add or edit.

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

Adds or edits multiple instances of EmailQueue class.

Parameters

collection Your collection of EmailQueue class to bulk import.

Returns: Returns list of imported queueIds.

Exceptions

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

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

Counts the number of email queues.

Returns: Returns the count of the email queues.

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

Counts the number of email queues using the supplied filter name.

Parameters

filterName The named filter.

Returns: Returns the count of filtered email queues.

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

Counts the number of email queues using the supplied filter(s).

Parameters

filters The list of filter conditions.

Returns: Returns the count of filtered email queues.

void MixERP.Net.Api.Core.EmailQueueController.Delete ( long queueId )

Deletes an existing instance of EmailQueue class via QueueId.

Parameters

queueId Enter the value for QueueId in order to find and delete the existing record.

void MixERP.Net.Api.Core.EmailQueueController.Edit	(	long	queueId,
		[FromBody] MixERP.Net.Entities.Core.EmailQueue	emailQueue
	)

Edits existing record with your instance of EmailQueue class.

Parameters

emailQueue	Your instance of EmailQueue class to edit.
queueId	Enter the value for QueueId in order to find and edit the existing record.

IEnumerable<MixERP.Net.Entities.Core.EmailQueue> MixERP.Net.Api.Core.EmailQueueController.Get ( )

Returns collection of email queue for export.

Returns

MixERP.Net.Entities.Core.EmailQueue MixERP.Net.Api.Core.EmailQueueController.Get ( long queueId )

Returns an instance of email queue.

Parameters

queueId Enter QueueId to search for.

Returns

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

A custom field is a user defined field for email queues.

Returns: Returns an enumerable custom field collection of email queues.

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

A custom field is a user defined field for email queues.

Returns: Returns an enumerable custom field collection of email queues.

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

Displayfield is a lightweight key/value collection of email queues.

Returns: Returns an enumerable key/value collection of email queues.

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

Creates meta information of "email queue" entity.

Returns: Returns the "email queue" meta information to perform CRUD operation.

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

Creates a filtered and paginated collection containing 25 email queues on each page, sorted by the property QueueId.

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.EmailQueue> MixERP.Net.Api.Core.EmailQueueController.GetPagedResult ( )

Creates a paginated collection containing 25 email queues on each page, sorted by the property QueueId.

Returns: Returns the first page from the collection.

IEnumerable<MixERP.Net.Entities.Core.EmailQueue> MixERP.Net.Api.Core.EmailQueueController.GetPagedResult ( long pageNumber )

Creates a paginated collection containing 25 email queues on each page, sorted by the property QueueId.

Parameters

pageNumber Enter the page number to produce the resultset.

Returns: Returns the requested page from the collection.

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

Creates a filtered and paginated collection containing 25 email queues on each page, sorted by the property QueueId.

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/EmailQueueController.cs

Public Member Functions

Properties

Detailed Description

Member Function Documentation