C# Класс ConstructorIO.ConstructorIOAPI

Показать файл Открыть проект Примеры использования класса

Private Properties

Свойство	Тип	Описание

Открытые методы

Метод	Описание
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.

Описание методов

Add() публичный Метод

Adds Item to your autocomplete.

public Add ( ListItem Item ) : bool
Item	ListItem	The item to add
Результат	bool

AddAsync() публичный Метод

Adds an Item to your autocomplete.

public AddAsync ( ListItem Item ) : Task
Item	ListItem	The item to add
Результат	Task

AddBatch() публичный Метод

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.
Результат	bool

AddBatch() публичный Метод

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.
Результат	bool

AddBatchAsync() публичный Метод

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.
Результат	Task

AddBatchAsync() публичный Метод

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.
Результат	Task

AddOrUpdate() публичный Метод

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

public AddOrUpdate ( ListItem Item ) : bool
Item	ListItem	The item to add or update
Результат	bool

AddOrUpdateAsync() публичный Метод

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

public AddOrUpdateAsync ( ListItem Item ) : Task
Item	ListItem	The item to add or update
Результат	Task

AddOrUpdateBatch() публичный Метод

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.
Результат	bool

AddOrUpdateBatch() публичный Метод

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.
Результат	bool

AddOrUpdateBatchAsync() публичный Метод

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.
Результат	Task

AddOrUpdateBatchAsync() публичный Метод

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.
Результат	Task

ConstructorIOAPI() публичный Метод

public ConstructorIOAPI ( string APIKey, string AutocompleteKey, string Host = "ac.cnstrc.com" ) : System
APIKey	string
AutocompleteKey	string
Host	string
Результат	System

Modify() публичный Метод

Modifies an existing item

public Modify ( ListItem ItemToModify ) : bool
ItemToModify	ListItem
Результат	bool

ModifyAsync() публичный Метод

Modifies an existing item

public ModifyAsync ( ListItem ItemToUpdate ) : Task
ItemToUpdate	ListItem	The item to udpate
Результат	Task

Remove() публичный Метод

Removes an item from your autocomplete.

public Remove ( ListItem Item ) : bool
Item	ListItem
Результат	bool

RemoveAsync() публичный Метод

Removes an item from your autocomplete.

public RemoveAsync ( ListItem ItemToRemove ) : Task
ItemToRemove	ListItem	The item to remove.
Результат	Task

RemoveBatch() публичный Метод

Removed multiple items from your autocomplete.

public RemoveBatch ( IEnumerable Items, ListItemAutocompleteType AutocompleteSection ) : bool
Items	IEnumerable
AutocompleteSection	ListItemAutocompleteType	The autocomplete section to remove from.
Результат	bool

RemoveBatch() публичный Метод

Removed multiple items from your autocomplete.

public RemoveBatch ( IEnumerable Items, string AutocompleteSection ) : bool
Items	IEnumerable
AutocompleteSection	string	The autocomplete section to remove from.
Результат	bool

RemoveBatchAsync() публичный Метод

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.
Результат	Task

Verify() публичный Метод

Verify that the API key is valid.

public Verify ( ) : bool
Результат	bool

VerifyAsync() публичный Метод

Verify that the API key is valid.

public VerifyAsync ( ) : Task
Результат	Task