Atalasoft MobileImage API Reference
Instance Methods | List of all members
<KFXBundleFileProtocol> Protocol Reference

Bundle file protocol. More...

#import <KFXBundleProtocol.h>

Inheritance diagram for <KFXBundleFileProtocol>:

Instance Methods

(BOOL) - isDirectory
 Is directory. More...
 
(NSString *) - getFilePathWithError:
 Get path to file. More...
 
(void) - writeFileToPath:error:
 Write file to specified path. More...
 
(NSString *) - absolutePath
 Absolute file path. More...
 
(NSString *) - name
 File name. More...
 

Detailed Description

Bundle file protocol.

This class represents a single file inside a corresponding bundle.

See also
KFXBundleProtocol

Method Documentation

- (NSString*) absolutePath

Absolute file path.

The absolute path within whatever storage container this file resides.

Returns
absolute path to file.
- (NSString*) getFilePathWithError: (NSError **)  error

Get path to file.

This method allows to obtain default path to file. Default implementations write files to application's temporary directory. This path may be overwritten by other files during bundle enumeration. If file is needed to be stored for future usage, use writeFileToPath: method.

Parameters
error- will contain error if there is any.
Returns
path to file.
- (BOOL) isDirectory

Is directory.

Indicates if the file is a directory.

Returns
YES if file is a directory and NO otherwise.
- (NSString*) name

File name.

File name without any path information.

Returns
file name.
- (void) writeFileToPath: (NSString *)  path
error: (NSError **)  error 

Write file to specified path.

This method allows to write file to a custom path.

Parameters
path- custom path to the file.
error- will contain error if there is any.

The documentation for this protocol was generated from the following file:
Untitled Document © 2016 Atalasoft, Inc., 116 Pleasant St, Suite 321, Easthampton, MA 01027, U.S.A. All rights reserved. Use is subject to license terms.