You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
91 lines
3.2 KiB
91 lines
3.2 KiB
9 years ago
|
/**
|
||
|
|
* 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.
|
||
|
|
*/
|
||
|
|
|
||
|
|
#import <Foundation/Foundation.h>
|
||
|
|
|
||
|
|
#import <Bolts/BFTask.h>
|
||
|
|
|
||
|
|
#import <Parse/PFConstants.h>
|
||
|
|
|
||
|
|
NS_ASSUME_NONNULL_BEGIN
|
||
|
|
|
||
|
|
/**
|
||
|
|
The `PFCloud` class provides methods for interacting with Parse Cloud Functions.
|
||
|
|
*/
|
||
|
|
@interface PFCloud : NSObject
|
||
|
|
|
||
|
|
/**
|
||
|
|
Calls the given cloud function *synchronously* with the parameters provided.
|
||
|
|
|
||
|
|
@param function The function name to call.
|
||
|
|
@param parameters The parameters to send to the function.
|
||
|
|
|
||
|
|
@return The response from the cloud function.
|
||
|
|
*/
|
||
|
|
+ (nullable id)callFunction:(NSString *)function withParameters:(nullable NSDictionary *)parameters PF_SWIFT_UNAVAILABLE;
|
||
|
|
|
||
|
|
/**
|
||
|
|
Calls the given cloud function *synchronously* with the parameters provided and
|
||
|
|
sets the error if there is one.
|
||
|
|
|
||
|
|
@param function The function name to call.
|
||
|
|
@param parameters The parameters to send to the function.
|
||
|
|
@param error Pointer to an `NSError` that will be set if necessary.
|
||
|
|
|
||
|
|
@return The response from the cloud function.
|
||
|
|
This result could be a `NSDictionary`, an `NSArray`, `NSNumber` or `NSString`.
|
||
|
|
*/
|
||
|
|
+ (nullable id)callFunction:(NSString *)function
|
||
|
|
withParameters:(nullable NSDictionary *)parameters
|
||
|
|
error:(NSError **)error;
|
||
|
|
|
||
|
|
/**
|
||
|
|
Calls the given cloud function *asynchronously* with the parameters provided.
|
||
|
|
|
||
|
|
@param function The function name to call.
|
||
|
|
@param parameters The parameters to send to the function.
|
||
|
|
|
||
|
|
@return The task, that encapsulates the work being done.
|
||
|
|
*/
|
||
|
|
+ (BFTask PF_GENERIC(id) *)callFunctionInBackground:(NSString *)function
|
||
|
|
withParameters:(nullable NSDictionary *)parameters;
|
||
|
|
|
||
|
|
/**
|
||
|
|
Calls the given cloud function *asynchronously* with the parameters provided
|
||
|
|
and executes the given block when it is done.
|
||
|
|
|
||
|
|
@param function The function name to call.
|
||
|
|
@param parameters The parameters to send to the function.
|
||
|
|
@param 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
|
||
|
|
block:(nullable PFIdResultBlock)block;
|
||
|
|
|
||
|
|
/*
|
||
|
|
Calls the given cloud function *asynchronously* with the parameters provided
|
||
|
|
and then executes the given selector when it is done.
|
||
|
|
|
||
|
|
@param function The function name to call.
|
||
|
|
@param parameters The parameters to send to the function.
|
||
|
|
@param target The object to call the selector on.
|
||
|
|
@param 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.
|
||
|
|
*/
|
||
|
|
+ (void)callFunctionInBackground:(NSString *)function
|
||
|
|
withParameters:(nullable NSDictionary *)parameters
|
||
|
|
target:(nullable id)target
|
||
|
|
selector:(nullable SEL)selector;
|
||
|
|
|
||
|
|
@end
|
||
|
|
|
||
|
|
NS_ASSUME_NONNULL_END
|