API Documentation

\google\appengine\api\taskqueue\PushQueue

FINAL

A PushQueue executes PushTasks by sending the task back to the application in the form of an HTTP request to one of the application's handlers.

Constants

MAX_TASKS_PER_ADD

The maximum number of tasks in a single call addTasks.

Methods

__construct

__construct(string $name = 'default')

Construct a PushQueue

Parameters

Name Description

$name

string

The name of the queue.

getName

getName() : string

Return the queue's name.

Returns

string

The queue's name.

addTasks

addTasks(array<mixed,\google\appengine\api\taskqueue\PushTask> $tasks) : \google\appengine\api\taskqueue\An

Add tasks to the queue.

Parameters

Name Description

$tasks

array<mixed,\google\appengine\api\taskqueue\PushTask>

The tasks to be added to the queue.

Throws

\google\appengine\api\taskqueue\TaskAlreadyExistsException

if a task of the same name already exists in the queue. If this exception is raised, the caller can be guaranteed that all tasks were successfully added either by this call or a previous call. Another way to express it is that, if any task failed to be added for a different reason, a different exception will be thrown.

\google\appengine\api\taskqueue\TaskQueueException

if there was a problem using the service.

Returns

\google\appengine\api\taskqueue\An

array containing the name of each task added, with the same ordering as $tasks.

Send feedback about...

App Engine standard environment for PHP