SearchIndexingBufferedSender class
Třída používaná k provádění operací uložených ve vyrovnávací paměti s indexem vyhledávání, včetně jejich přidávání, aktualizace a odebírání.
Konstruktory
Search |
Vytvoří novou instanci SearchIndexingBufferedSender. |
Metody
Podrobnosti konstruktoru
SearchIndexingBufferedSender<TModel>(IndexDocumentsClient<TModel>, (document: TModel) => string, SearchIndexingBufferedSenderOptions)
Vytvoří novou instanci SearchIndexingBufferedSender.
new SearchIndexingBufferedSender(client: IndexDocumentsClient<TModel>, documentKeyRetriever: (document: TModel) => string, options?: SearchIndexingBufferedSenderOptions)
Parametry
- client
-
IndexDocumentsClient<TModel>
Klient vyhledávání, který se používá k volání základních operací IndexBatch.
- documentKeyRetriever
-
(document: TModel) => string
Možnosti pro úpravu automatického vyprázdnění
Podrobnosti metody
deleteDocuments(TModel[], OperationOptions)
Odstraní dokumenty nebo přidá dokumenty do fronty odstranění.
function deleteDocuments(documents: TModel[], options?: OperationOptions): Promise<void>
Parametry
- documents
-
TModel[]
Dokumenty, které se mají odstranit.
- options
- OperationOptions
Možnosti nahrání
Návraty
Promise<void>
dispose()
Pokud používáte autoFlush: true, voláním tohoto příkazu vyčistíte časovač autoflush.
function dispose(): Promise<void>
Návraty
Promise<void>
flush(OperationOptions)
Vyprázdní frontu ručně.
function flush(options?: OperationOptions): Promise<void>
Parametry
- options
- OperationOptions
Možnosti vyprázdnění.
Návraty
Promise<void>
mergeDocuments(TModel[], OperationOptions)
Sloučí dokumenty nebo přidá dokumenty do fronty sloučení.
function mergeDocuments(documents: TModel[], options?: OperationOptions): Promise<void>
Parametry
- documents
-
TModel[]
Dokumenty, které se mají sloučit.
- options
- OperationOptions
Možnosti nahrání
Návraty
Promise<void>
mergeOrUploadDocuments(TModel[], OperationOptions)
Sloučí, nahraje dokumenty nebo přidá dokumenty do fronty pro sloučení nebo nahrání.
function mergeOrUploadDocuments(documents: TModel[], options?: OperationOptions): Promise<void>
Parametry
- documents
-
TModel[]
Dokumenty, které se mají sloučit nebo nahrát.
- options
- OperationOptions
Možnosti nahrání
Návraty
Promise<void>
off("batchAdded", (e: { action: string, documents: TModel[] }) => void)
Odpojení události přidání dávky
function off(event: "batchAdded", listener: (e: { action: string, documents: TModel[] }) => void)
Parametry
- event
-
"batchAdded"
Událost, která se má vygenerovat
- listener
-
(e: { action: string, documents: TModel[] }) => void
Event Listener
off("batchFailed", (e: RestError) => void)
Událost selhání dávky odpojení
function off(event: "batchFailed", listener: (e: RestError) => void)
Parametry
- event
-
"batchFailed"
Událost, která se má vygenerovat
- listener
-
(e: RestError) => void
Event Listener
off("batchSucceeded", (e: IndexDocumentsResult) => void)
Událost Detach Batch Succeeded
function off(event: "batchSucceeded", listener: (e: IndexDocumentsResult) => void)
Parametry
- event
-
"batchSucceeded"
Událost, která se má vygenerovat
- listener
-
(e: IndexDocumentsResult) => void
Event Listener
off("beforeDocumentSent", (e: IndexDocumentsAction<TModel>) => void)
Událost odesílané dávky odpojení
function off(event: "beforeDocumentSent", listener: (e: IndexDocumentsAction<TModel>) => void)
Parametry
- event
-
"beforeDocumentSent"
Událost, která se má vygenerovat
- listener
-
(e: IndexDocumentsAction<TModel>) => void
Event Listener
on("batchAdded", (e: { action: string, documents: TModel[] }) => void)
Připojit událost přidání dávky
function on(event: "batchAdded", listener: (e: { action: string, documents: TModel[] }) => void)
Parametry
- event
-
"batchAdded"
Událost, která se má vygenerovat
- listener
-
(e: { action: string, documents: TModel[] }) => void
Event Listener
on("batchFailed", (e: RestError) => void)
Připojení události selhání dávky
function on(event: "batchFailed", listener: (e: RestError) => void)
Parametry
- event
-
"batchFailed"
Událost, která se má vygenerovat
- listener
-
(e: RestError) => void
Event Listener
on("batchSucceeded", (e: IndexDocumentsResult) => void)
Událost Připojení dávky byla úspěšná
function on(event: "batchSucceeded", listener: (e: IndexDocumentsResult) => void)
Parametry
- event
-
"batchSucceeded"
Událost, která se má vygenerovat
- listener
-
(e: IndexDocumentsResult) => void
Event Listener
on("beforeDocumentSent", (e: IndexDocumentsAction<TModel>) => void)
Připojit dávkově odeslanou událost
function on(event: "beforeDocumentSent", listener: (e: IndexDocumentsAction<TModel>) => void)
Parametry
- event
-
"beforeDocumentSent"
Událost, která se má vygenerovat
- listener
-
(e: IndexDocumentsAction<TModel>) => void
Event Listener
uploadDocuments(TModel[], OperationOptions)
Nahraje dokumenty nebo přidá dokumenty do fronty pro nahrání.
function uploadDocuments(documents: TModel[], options?: OperationOptions): Promise<void>
Parametry
- documents
-
TModel[]
Dokumenty, které se mají nahrát.
- options
- OperationOptions
Možnosti nahrání
Návraty
Promise<void>