Meilisearch PHP | Documentation

UpdateWebhookQuery
in package

FinalYes
Tags
since

Meilisearch v1.17.0

Table of Contents

Properties

$uuid  : string
$hasHeaders  : bool
$headers  : array<non-empty-string, string|null>|null
$url  : non-empty-string|null

Methods

__construct()  : mixed
setHeaders()  : $this
Headers are merged into the existing ones: a null value removes that header, and passing null instead of a map removes all headers.
setUrl()  : $this
toArray()  : array<string|int, mixed>
Builds the PATCH body from the fields that were set. An empty headers map is omitted because it would leave the existing headers unchanged anyway.

Properties

Methods

__construct()

public __construct(non-empty-string $uuid) : mixed
Parameters
$uuid : non-empty-string

setHeaders()

Headers are merged into the existing ones: a null value removes that header, and passing null instead of a map removes all headers.

public setHeaders(array<non-empty-string, string|null>|null $headers) : $this
Parameters
$headers : array<non-empty-string, string|null>|null
Return values
$this

setUrl()

public setUrl(non-empty-string $url) : $this
Parameters
$url : non-empty-string

the URL Meilisearch notifies when a task finishes

Return values
$this

toArray()

Builds the PATCH body from the fields that were set. An empty headers map is omitted because it would leave the existing headers unchanged anyway.

public toArray() : array<string|int, mixed>
Return values
array<string|int, mixed>
On this page

Search results