Parse PHP SDK API Reference

ParseCloud
in package

Class ParseCloud - Facilitates calling Parse Cloud functions.

Tags
author

Fosco Marotto [email protected]

Table of Contents

getJobsData()  : array<string|int, mixed>
Gets data for the current set of cloud jobs
getJobStatus()  : array<string|int, mixed>|ParseObject
Gets job status by id
run()  : mixed
Makes a call to a Cloud function.
startJob()  : string
Starts a given cloud job, which will process asynchronously

Methods

getJobsData()

Gets data for the current set of cloud jobs

public static getJobsData() : array<string|int, mixed>
Return values
array<string|int, mixed>

getJobStatus()

Gets job status by id

public static getJobStatus(string $jobStatusId) : array<string|int, mixed>|ParseObject
Parameters
$jobStatusId : string

Id of the job status to return

Return values
array<string|int, mixed>|ParseObject

run()

Makes a call to a Cloud function.

public static run(string $name[, array<string|int, mixed> $data = [] ][, bool $useMasterKey = false ]) : mixed
Parameters
$name : string

Cloud function name

$data : array<string|int, mixed> = []

Parameters to pass

$useMasterKey : bool = false

Whether to use the Master Key

Return values
mixed

startJob()

Starts a given cloud job, which will process asynchronously

public static startJob(string $jobName[, array<string|int, mixed> $data = [] ]) : string
Parameters
$jobName : string

Name of job to run

$data : array<string|int, mixed> = []

Parameters to pass

Return values
string

Id for tracking job status

Search results