PFCloud Class Reference

#import <PFCloud.h>

Inheritance diagram for PFCloud:

Class Methods
(BFTask< id > *)	+ callFunctionInBackground:withParameters:
(void)	+ callFunctionInBackground:withParameters:block:
(void)	+ callFunctionInBackground:withParameters:target:selector:
(nullable id)	+ callFunction:withParameters:
(nullable id)	+ callFunction:withParameters:error:

Detailed Description

Copyright (c) 2015-present, Parse, LLC. All rights reserved.

This source code is licensed under the BSD-style license found in the LICENSE file in the root directory of this source tree. An additional grant of patent rights can be found in the PATENTS file in the same directory. The PFCloud class provides methods for interacting with Parse Cloud Functions.

Method Documentation

+ (nullable id) callFunction:		(NSString *)	function
withParameters:		(nullable NSDictionary *)	PF_SWIFT_UNAVAILABLE

Calls the given cloud function synchronously with the parameters provided.

Parameters

function	The function name to call.
parameters	The parameters to send to the function.

Returns

The response from the cloud function.

Provided by category PFCloud(Synchronous).

+ (nullable id) callFunction:		(NSString *)	function
withParameters:		(nullable NSDictionary *)	parameters
error:		(NSError **)	error

Calls the given cloud function synchronously with the parameters provided and sets the error if there is one.

Parameters

function	The function name to call.
parameters	The parameters to send to the function.
error	Pointer to an NSError that will be set if necessary.

Returns

The response from the cloud function. This result could be a NSDictionary, an NSArray, NSNumber or NSString.

Provided by category PFCloud(Synchronous).

+ (BFTask<id> *) callFunctionInBackground:		(NSString *)	function
withParameters:		(nullable NSDictionary *)	parameters

Calls the given cloud function asynchronously with the parameters provided.

Parameters

function	The function name to call.
parameters	The parameters to send to the function.

Returns

The task, that encapsulates the work being done.

+ (void) callFunctionInBackground:		(NSString *)	function
withParameters:		(nullable NSDictionary *)	parameters
block:		(nullable PFIdResultBlock)	block

Calls the given cloud function asynchronously with the parameters provided and executes the given block when it is done.

Parameters

function	The function name to call.
parameters	The parameters to send to the function.
block	The block to execute when the function call finished. It should have the following argument signature: ^(id result, NSError *error).

+ (void) callFunctionInBackground:		(NSString *)	function
withParameters:		(nullable NSDictionary *)	parameters
target:		(nullable id)	target
selector:		("Please use `PFCloud.+callFunctionInBackground:withParameters:` instead.")	PARSE_DEPRECATED

Calls the given cloud function asynchronously with the parameters provided and then executes the given selector when it is done.

Parameters

function	The function name to call.
parameters	The parameters to send to the function.
target	The object to call the selector on.
selector	The selector to call when the function call finished. It should have the following signature: (void)callbackWithResult:(id)result error:(NSError *)error. Result will be nil if error is set and vice versa.

Deprecated:

Please use PFCloud.+callFunctionInBackground:withParameters: instead.

Provided by category PFCloud(Deprecated).

---

The documentation for this class was generated from the following file:

• Frameworks/Parse.framework/Headers/PFCloud.h