EOSFile Class Reference
| Inherits from | EOSObject : NSObject |
| Declared in | EOSFile.h EOSFile.m |
Tasks
Initialization
Getting File Information
Getting and Setting Attributes
Getting Files
Downloading
Removing
Instance Methods
attribute:
Gets the attribute of the file.
- (EOSFileAttribute)attribute:(NSError *__autoreleasing *)errorParameters
- error
If unsuccessful, an instance of NSError will describe the problem.
Return Value
If successful an EOSFileAttribute value, otherwise NSNotFound.
Declared In
EOSFile.hdownloadWithOptions:delegate:contextInfo:
Downloads the file asynchronously.
- (void)downloadWithOptions:(NSDictionary *)options delegate:(id<EOSDownloadDelegate>)delegate contextInfo:(id)contextInfoParameters
- options
A dictionary of options.
- delegate
The download delegate.
- contextInfo
An object that will be passed to the delegate methods. Can be nil.
Discussion
When the download is completed, the didDownloadFile:withOptions:contextInfo:error method of the delegate object is called. The content of the error returned should be examined to determine if the download completed successfully. See EOSDownloadDelegate for more information. The options dictionary may contain the keys; EOSDownloadDirectoryURL, EOSSaveAsFilename and EOSOverwrite.
Declared In
EOSFile.hfileAtIndex:error:
Gets the file that is directly contained within a directory at the specified index.
- (EOSFile *)fileAtIndex:(NSUInteger)index error:(NSError *__autoreleasing *)errorParameters
- index
The index of the file to get
- error
If unsuccessful, an instance of NSError describes the problem
Return Value
If successful, an EOSFile object representing the file, otherwise nil
Discussion
Use fileCount: to find the valid index range.
Declared In
EOSFile.hfileCount:
Gets the number of files that are directly contained within a directory.
- (NSNumber *)fileCount:(NSError *__autoreleasing *)errorParameters
- error
If unsuccessful, an instance of NSError describes the problem.
Return Value
If successful, the number of children, otherwise nil.
Declared In
EOSFile.hfiles
Gets all of the files that are directly contained within a directory.
- (NSArray *)filesReturn Value
an array containing instances of EOSFile.
Discussion
If there is an error retrieving a child, the function will continue without adding it to the array. If you need to check for errors when reteiving each file, use fileAtIndex:error: instead.
Declared In
EOSFile.hinfo:
Gets information about the file.
- (EOSFileInfo *)info:(NSError *__autoreleasing *)errorParameters
- error
If unsuccessful, an instance of NSError will describe the problem.
Return Value
if successful, an EOSFileInfo object, otherwise nil
Declared In
EOSFile.hinitWithDirectoryItemRef:
Initializes a newly allocated EOSFile instance with a reference to an EDSDK file object.
- (id)initWithDirectoryItemRef:(EdsDirectoryItemRef)fileRefParameters
- fileRef
The EDSDK file reference.
Return Value
The initialized EOSFile object.
Declared In
EOSFile.hremove:
Deletes the file.
- (BOOL)remove:(NSError *__autoreleasing *)errorParameters
- error
If unsuccessful, an instance of NSError will describe the problem.
Return Value
YES if successful, otherwise NO.
Discussion
If the file is a directory, all of its content is deleted except protected files.
Declared In
EOSFile.hsetAttribute:error:
Sets the attribute of the file.
- (BOOL)setAttribute:(EOSFileAttribute)attribute error:(NSError *__autoreleasing *)errorParameters
- attribute
The new attribute.
- error
If unsuccessful, an instance of NSError will describe the problem.
Return Value
YES if successful, otherwise NO.
Declared In
EOSFile.h