PFFile(Synchronous) Category Reference

#import <PFFile+Synchronous.h>

Instance Methods
(BOOL)	- PF_SWIFT_UNAVAILABLE
	More...
(BOOL)	- save:
(nullable NSData *)	- PF_SWIFT_UNAVAILABLE
(nullable NSData *)	- getData:
(nullable NSInputStream *)	- PF_SWIFT_UNAVAILABLE
(nullable NSInputStream *)	- getDataStream:

Properties
BOOL	dataAvailable
	More...

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. This category lists all methods of PFFile class that are synchronous, but have asynchronous counterpart, Calling one of these synchronous methods could potentially block the current thread for a large amount of time, since it might be fetching from network or saving/loading data from disk.

Method Documentation

- (nullable NSData *) getData:

(NSError **)

error

Synchronously* gets the data from cache if available or fetches its contents from the network. Sets an error if it occurs.

Parameters

error

Pointer to an NSError that will be set if necessary.

Returns

The NSData object containing file data. Returns nil if there was an error in fetching.

Extends class PFFile.

- (nullable NSInputStream *) getDataStream:

(NSError **)

error

This method is like -getData but avoids ever holding the entire PFFile contents in memory at once.

Parameters

error

Pointer to an NSError that will be set if necessary.

Returns

A stream containing the data. Returns nil if there was an error in fetching.

Extends class PFFile.

- (nullable NSInputStream *) PF_SWIFT_UNAVAILABLE

This method is like -getData but avoids ever holding the entire PFFile contents in memory at once.

This can help applications with many large files avoid memory warnings.

Returns

A stream containing the data. Returns nil if there was an error in fetching.

Extends class PFFile.

- (nullable NSData *) PF_SWIFT_UNAVAILABLE

Synchronously* gets the data from cache if available or fetches its contents from the network.

Returns

The NSData object containing file data. Returns nil if there was an error in fetching.

Extends class PFFile.

- (BOOL) PF_SWIFT_UNAVAILABLE

---

---

Saves the file synchronously.

Returns

Returns whether the save succeeded.

Extends class PFFile.

- (BOOL) save:

(NSError **)

error

Saves the file synchronously and sets an error if it occurs.

Parameters

error

Pointer to an NSError that will be set if necessary.

Returns

Returns whether the save succeeded.

Extends class PFFile.

Property Documentation

- (BOOL) dataAvailable

readnonatomicassign

---

---

Whether the data is available in memory or needs to be downloaded.

Extends class PFFile.

---

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

• Frameworks/Parse.framework/Headers/PFFile+Synchronous.h