Meilisearch PHP | Documentation

Tasks extends Endpoint
in package

Table of Contents

Constants

PATH  = ''

Properties

$apiKey  : string|null
$http  : Http

Methods

__construct()  : mixed
all()  : array<string|int, mixed>
cancelTasks()  : array<string|int, mixed>
deleteTasks()  : array<string|int, mixed>
get()  : array<string|int, mixed>
show()  : array<string|int, mixed>|null
waitTask()  : array<string|int, mixed>
waitTasks()  : array<string|int, mixed>

Constants

Properties

Methods

__construct()

public __construct(Http $http[, string|null $apiKey = null ]) : mixed
Parameters
$http : Http
$apiKey : string|null = null

all()

public all([array<string|int, mixed> $query = [] ]) : array<string|int, mixed>
Parameters
$query : array<string|int, mixed> = []
Return values
array<string|int, mixed>

get()

public get(mixed $taskUid) : array<string|int, mixed>
Parameters
$taskUid : mixed
Return values
array<string|int, mixed>

show()

public show() : array<string|int, mixed>|null
Return values
array<string|int, mixed>|null

waitTask()

public waitTask(mixed $taskUid, int $timeoutInMs, int $intervalInMs) : array<string|int, mixed>
Parameters
$taskUid : mixed
$timeoutInMs : int
$intervalInMs : int
Tags
throws
TimeOutException
Return values
array<string|int, mixed>

waitTasks()

public waitTasks(array<string|int, mixed> $taskUids, int $timeoutInMs, int $intervalInMs) : array<string|int, mixed>
Parameters
$taskUids : array<string|int, mixed>
$timeoutInMs : int
$intervalInMs : int
Tags
throws
TimeOutException
Return values
array<string|int, mixed>

On this page

Search results