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

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

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

long	Count ()
	Counts the number of social networks. More...

IEnumerable< MixERP.Net.Entities.Core.SocialNetwork >	Get ()
	Returns collection of social network for export. More...

MixERP.Net.Entities.Core.SocialNetwork	Get (string socialNetworkName)
	Returns an instance of social network. More...

IEnumerable< MixERP.Net.Entities.Core.SocialNetwork >	Get ([FromUri] string[] socialNetworkNames)

IEnumerable< MixERP.Net.Entities.Core.SocialNetwork >	GetPagedResult ()
	Creates a paginated collection containing 25 social networks on each page, sorted by the property SocialNetworkName. More...

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

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

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

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

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

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

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

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

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

void	Add (MixERP.Net.Entities.Core.SocialNetwork socialNetwork)
	Adds your instance of SocialNetwork class. More...

void	Edit (string socialNetworkName, [FromBody] MixERP.Net.Entities.Core.SocialNetwork socialNetwork)
	Edits existing record with your instance of SocialNetwork class. More...

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

void	Delete (string socialNetworkName)
	Deletes an existing instance of SocialNetwork class via SocialNetworkName. 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 Social Networks.

Member Function Documentation

void MixERP.Net.Api.Core.SocialNetworkController.Add ( MixERP.Net.Entities.Core.SocialNetwork socialNetwork )

Adds your instance of SocialNetwork class.

Parameters

socialNetwork Your instance of social networks class to add.

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

Adds or edits your instance of SocialNetwork class.

Parameters

socialNetwork Your instance of social networks class to add or edit.

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

Adds or edits multiple instances of SocialNetwork class.

Parameters

collection Your collection of SocialNetwork class to bulk import.

Returns: Returns list of imported socialNetworkNames.

Exceptions

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

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

Counts the number of social networks.

Returns: Returns the count of the social networks.

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

Counts the number of social networks using the supplied filter name.

Parameters

filterName The named filter.

Returns: Returns the count of filtered social networks.

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

Counts the number of social networks using the supplied filter(s).

Parameters

filters The list of filter conditions.

Returns: Returns the count of filtered social networks.

void MixERP.Net.Api.Core.SocialNetworkController.Delete ( string socialNetworkName )

Deletes an existing instance of SocialNetwork class via SocialNetworkName.

Parameters

socialNetworkName Enter the value for SocialNetworkName in order to find and delete the existing record.

void MixERP.Net.Api.Core.SocialNetworkController.Edit	(	string	socialNetworkName,
		[FromBody] MixERP.Net.Entities.Core.SocialNetwork	socialNetwork
	)

Edits existing record with your instance of SocialNetwork class.

Parameters

socialNetwork	Your instance of SocialNetwork class to edit.
socialNetworkName	Enter the value for SocialNetworkName in order to find and edit the existing record.

IEnumerable<MixERP.Net.Entities.Core.SocialNetwork> MixERP.Net.Api.Core.SocialNetworkController.Get ( )

Returns collection of social network for export.

Returns

MixERP.Net.Entities.Core.SocialNetwork MixERP.Net.Api.Core.SocialNetworkController.Get ( string socialNetworkName )

Returns an instance of social network.

Parameters

socialNetworkName Enter SocialNetworkName to search for.

Returns

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

A custom field is a user defined field for social networks.

Returns: Returns an enumerable custom field collection of social networks.

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

A custom field is a user defined field for social networks.

Returns: Returns an enumerable custom field collection of social networks.

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

Displayfield is a lightweight key/value collection of social networks.

Returns: Returns an enumerable key/value collection of social networks.

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

Creates meta information of "social network" entity.

Returns: Returns the "social network" meta information to perform CRUD operation.

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

Creates a filtered and paginated collection containing 25 social networks on each page, sorted by the property SocialNetworkName.

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

Creates a paginated collection containing 25 social networks on each page, sorted by the property SocialNetworkName.

Returns: Returns the first page from the collection.

IEnumerable<MixERP.Net.Entities.Core.SocialNetwork> MixERP.Net.Api.Core.SocialNetworkController.GetPagedResult ( long pageNumber )

Creates a paginated collection containing 25 social networks on each page, sorted by the property SocialNetworkName.

Parameters

pageNumber Enter the page number to produce the resultset.

Returns: Returns the requested page from the collection.

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

Creates a filtered and paginated collection containing 25 social networks on each page, sorted by the property SocialNetworkName.

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

Public Member Functions

Properties

Detailed Description

Member Function Documentation