C# Class ConstructorIO.ConstructorIOAPI

Afficher le fichier Open project: Constructor-io/constructorio-csharp Class Usage Examples

Private Properties

Свойство	Type	Description

Méthodes publiques

Méthode	Description
Add ( ListItem Item ) : bool	Adds Item to your autocomplete.
AddAsync ( ListItem Item ) : Task	Adds an Item to your autocomplete.
AddBatch ( IEnumerable Items, ListItemAutocompleteType AutocompleteSection ) : bool	Adds multiple items in one batch upload.
AddBatch ( IEnumerable Items, string AutocompleteSection ) : bool	Adds multiple items in one batch upload.
AddBatchAsync ( IEnumerable Items, ListItemAutocompleteType AutocompleteSection ) : Task	Adds multiple items in one batch upload.
AddBatchAsync ( IEnumerable Items, string AutocompleteSection ) : Task	Adds multiple items in one batch upload.
AddOrUpdate ( ListItem Item ) : bool	Adds an Item or Updates an existing item in your autocomplete.
AddOrUpdateAsync ( ListItem Item ) : Task	Adds an Item or Updates an existing item in your autocomplete.
AddOrUpdateBatch ( IEnumerable Items, ListItemAutocompleteType AutocompleteSection ) : bool	Adds or Updates multiple items in one batch.
AddOrUpdateBatch ( IEnumerable Items, string AutocompleteSection ) : bool	Adds or Updates multiple items in one batch.
AddOrUpdateBatchAsync ( IEnumerable Items, ListItemAutocompleteType AutocompleteSection ) : Task	Adds or Updates multiple items in one batch.
AddOrUpdateBatchAsync ( IEnumerable Items, string AutocompleteSection ) : Task	Adds or Updates multiple items in one batch.
ConstructorIOAPI ( string APIKey, string AutocompleteKey, string Host = "ac.cnstrc.com" ) : System
Modify ( ListItem ItemToModify ) : bool	Modifies an existing item
ModifyAsync ( ListItem ItemToUpdate ) : Task	Modifies an existing item
Remove ( ListItem Item ) : bool	Removes an item from your autocomplete.
RemoveAsync ( ListItem ItemToRemove ) : Task	Removes an item from your autocomplete.
RemoveBatch ( IEnumerable Items, ListItemAutocompleteType AutocompleteSection ) : bool	Removed multiple items from your autocomplete.
RemoveBatch ( IEnumerable Items, string AutocompleteSection ) : bool	Removed multiple items from your autocomplete.
RemoveBatchAsync ( IEnumerable ItemsToRemove, string AutocompleteSection ) : Task	Removed multiple items from your autocomplete.
Verify ( ) : bool	Verify that the API key is valid.
VerifyAsync ( ) : Task	Verify that the API key is valid.

Method Details

Add() public méthode

Adds Item to your autocomplete.

public Add ( ListItem Item ) : bool
Item	ListItem	The item to add
Résultat	bool

AddAsync() public méthode

Adds an Item to your autocomplete.

public AddAsync ( ListItem Item ) : Task
Item	ListItem	The item to add
Résultat	Task

AddBatch() public méthode

Adds multiple items in one batch upload.

public AddBatch ( IEnumerable Items, ListItemAutocompleteType AutocompleteSection ) : bool
Items	IEnumerable	The items to add.
AutocompleteSection	ListItemAutocompleteType	The section the items should be added to.
Résultat	bool

AddBatch() public méthode

Adds multiple items in one batch upload.

public AddBatch ( IEnumerable Items, string AutocompleteSection ) : bool
Items	IEnumerable	The items to add.
AutocompleteSection	string	The section the items should be added to.
Résultat	bool

AddBatchAsync() public méthode

Adds multiple items in one batch upload.

public AddBatchAsync ( IEnumerable Items, ListItemAutocompleteType AutocompleteSection ) : Task
Items	IEnumerable	The items to add.
AutocompleteSection	ListItemAutocompleteType	The section the items should be added to.
Résultat	Task

AddBatchAsync() public méthode

Adds multiple items in one batch upload.

public AddBatchAsync ( IEnumerable Items, string AutocompleteSection ) : Task
Items	IEnumerable	The items to add.
AutocompleteSection	string	The section the items should be added to.
Résultat	Task

AddOrUpdate() public méthode

Adds an Item or Updates an existing item in your autocomplete.

public AddOrUpdate ( ListItem Item ) : bool
Item	ListItem	The item to add or update
Résultat	bool

AddOrUpdateAsync() public méthode

Adds an Item or Updates an existing item in your autocomplete.

public AddOrUpdateAsync ( ListItem Item ) : Task
Item	ListItem	The item to add or update
Résultat	Task

AddOrUpdateBatch() public méthode

Adds or Updates multiple items in one batch.

public AddOrUpdateBatch ( IEnumerable Items, ListItemAutocompleteType AutocompleteSection ) : bool
Items	IEnumerable	The items to add or update.
AutocompleteSection	ListItemAutocompleteType	The section the items should be added to.
Résultat	bool

AddOrUpdateBatch() public méthode

Adds or Updates multiple items in one batch.

public AddOrUpdateBatch ( IEnumerable Items, string AutocompleteSection ) : bool
Items	IEnumerable	The items to add or update.
AutocompleteSection	string	The section the items should be added to.
Résultat	bool

AddOrUpdateBatchAsync() public méthode

Adds or Updates multiple items in one batch.

public AddOrUpdateBatchAsync ( IEnumerable Items, ListItemAutocompleteType AutocompleteSection ) : Task
Items	IEnumerable	The items to add or update.
AutocompleteSection	ListItemAutocompleteType	The section the items should be added to.
Résultat	Task

AddOrUpdateBatchAsync() public méthode

Adds or Updates multiple items in one batch.

public AddOrUpdateBatchAsync ( IEnumerable Items, string AutocompleteSection ) : Task
Items	IEnumerable	The items to add or update.
AutocompleteSection	string	The section the items should be added to.
Résultat	Task

ConstructorIOAPI() public méthode

public ConstructorIOAPI ( string APIKey, string AutocompleteKey, string Host = "ac.cnstrc.com" ) : System
APIKey	string
AutocompleteKey	string
Host	string
Résultat	System

Modify() public méthode

Modifies an existing item

public Modify ( ListItem ItemToModify ) : bool
ItemToModify	ListItem
Résultat	bool

ModifyAsync() public méthode

Modifies an existing item

public ModifyAsync ( ListItem ItemToUpdate ) : Task
ItemToUpdate	ListItem	The item to udpate
Résultat	Task

Remove() public méthode

Removes an item from your autocomplete.

public Remove ( ListItem Item ) : bool
Item	ListItem
Résultat	bool

RemoveAsync() public méthode

Removes an item from your autocomplete.

public RemoveAsync ( ListItem ItemToRemove ) : Task
ItemToRemove	ListItem	The item to remove.
Résultat	Task

RemoveBatch() public méthode

Removed multiple items from your autocomplete.

public RemoveBatch ( IEnumerable Items, ListItemAutocompleteType AutocompleteSection ) : bool
Items	IEnumerable
AutocompleteSection	ListItemAutocompleteType	The autocomplete section to remove from.
Résultat	bool

RemoveBatch() public méthode

Removed multiple items from your autocomplete.

public RemoveBatch ( IEnumerable Items, string AutocompleteSection ) : bool
Items	IEnumerable
AutocompleteSection	string	The autocomplete section to remove from.
Résultat	bool

RemoveBatchAsync() public méthode

Removed multiple items from your autocomplete.

public RemoveBatchAsync ( IEnumerable ItemsToRemove, string AutocompleteSection ) : Task
ItemsToRemove	IEnumerable	The items to remove.
AutocompleteSection	string	The autocomplete section to remove from.
Résultat	Task

Verify() public méthode

Verify that the API key is valid.

public Verify ( ) : bool
Résultat	bool

VerifyAsync() public méthode

Verify that the API key is valid.

public VerifyAsync ( ) : Task
Résultat	Task