NSObject(OBEXFileTransferServicesDelegate)

Overview

OBEXFileTransferServicesDelegate

Methods

-fileTransferServicesAbortComplete:error:

The delegate method that corresponds to the abort method

-fileTransferServicesConnectionComplete:error:

The delegate method that corresponds to the connect method

-fileTransferServicesCopyRemoteFileComplete:error:

The delegate method that corresponds to the getFileNamed:toLocalPathAndName: method

-fileTransferServicesCopyRemoteFileProgress:transferProgress:

The delegate method for receiving information on the GET transfer

-fileTransferServicesCreateFolderComplete:error:folder:

The delegate method that corresponds to the createFolderNamed: method.

-fileTransferServicesCreateFolderComplete:error:folderName:

The delegate method that corresponds to the createFolderNamed: method.

-fileTransferServicesDisconnectionComplete:error:

The delegate method that corresponds to the disconnect method

-fileTransferServicesFilePreparationComplete:error:

The delegate method for receiving information on the preparation of each file to send

-fileTransferServicesPathChangeComplete:error:finalPath:

The delegate method that corresponds to the changeCurrentFolderToRoot:, changeCurrentFolderBackward:, and changeCurrentFolderForward: methods

-fileTransferServicesRemoveItemComplete:error:removedItem:

The delegate method that corresponds to the removeItemNamed: method.

-fileTransferServicesRetrieveFolderListingComplete:error:listing:

The delegate method that corresponds to the retrieveFolderListing method

-fileTransferServicesSendFileComplete:error:

The delegate method that corresponds to the sendFile: method.

-fileTransferServicesSendFileProgress:transferProgress:

The delegate method for receiving information on the sendFile: transfer

The delegate method that corresponds to the abort method

- (void) fileTransferServicesAbortComplete:(OBEXFileTransferServices*)inServices 
        error:(OBEXError)inError; 

Discussion

Possible inError values are kOBEXSuccess and kOBEXTimeoutError

The delegate method that corresponds to the connect method

- (void) fileTransferServicesConnectionComplete:(OBEXFileTransferServices*)inServices 
        error:(OBEXError)inError; 

Discussion

inError will either be kOBEXSuccess or it will be an error returned by the OBEX Session

The delegate method that corresponds to the getFileNamed:toLocalPathAndName: method

- (void) fileTransferServicesCopyRemoteFileComplete:(OBEXFileTransferServices*)inServices 
        error:(OBEXError)inError; 

Discussion

This method will be called when the transfer operation has finished

The delegate method for receiving information on the GET transfer

- (void) fileTransferServicesCopyRemoteFileProgress:(OBEXFileTransferServices*)inServices 
        transferProgress:(NSDictionary*)inProgressDescription; 

Parameters

inProgressDescription

A dictionary containing information on the state of the transfer. The keys to this dictionary are defined in the OBEXFileTransferServicesDelegate category.

Discussion

This method will be called during the transfer operation

The delegate method that corresponds to the createFolderNamed: method.

fileTransferServicesCreateFolderComplete:error:folderName:

- (void) fileTransferServicesCreateFolderComplete:(OBEXFileTransferServices*)inServices 
        error:(OBEXError)inError folder:(NSString*)inFolderName; 

Parameters

inFolderName

The name of the newly created folder

The delegate method that corresponds to the createFolderNamed: method.

fileTransferServicesCreateFolderComplete:error:folder:

- (void) fileTransferServicesCreateFolderComplete:(OBEXFileTransferServices*)inServices 
        error:(OBEXError)inError folder:(NSString*)inFolderName; 

Parameters

inFolderName

The name of the newly created folder

The delegate method that corresponds to the disconnect method

- (void) fileTransferServicesDisconnectionComplete:(OBEXFileTransferServices*)inServices 
        error:(OBEXError)inError; 

Discussion

inError will be kOBEXSuccess on success. This method will also be called if the connection is lost to the server. Possible error codes include kOBEXSessionTransportDiedError, kOBEXSessionNoTransportError, and kOBEXSessionNotConnectedError.

The delegate method for receiving information on the preparation of each file to send

- (void) fileTransferServicesFilePreparationComplete: (OBEXFileTransferServices*) inServices 
        error: (OBEXError) inError; 

Discussion

This method will be called before the transfer operation.

The delegate method that corresponds to the changeCurrentFolderToRoot:, changeCurrentFolderBackward:, and changeCurrentFolderForward: methods

- (void) fileTransferServicesPathChangeComplete:(OBEXFileTransferServices*)inServices 
        error:(OBEXError)inError finalPath:(NSString*)inPath; 

Parameters

inPath

The current remote path

The delegate method that corresponds to the removeItemNamed: method.

- (void) fileTransferServicesRemoveItemComplete:(OBEXFileTransferServices*)inServices 
        error:(OBEXError)inError removedItem:(NSString*)inItemName; 

Parameters

inItemName

The name of the remote item that was removed

The delegate method that corresponds to the retrieveFolderListing method

- (void) fileTransferServicesRetrieveFolderListingComplete:(OBEXFileTransferServices*)inServices 
        error:(OBEXError)inError listing:(NSArray*)inListing; 

Parameters

inListing

An array of NSDictionary's that detail each file at the current path. The keys to this dictionary are defined in the OBEXFileTransferServicesDelegate category.

The delegate method that corresponds to the sendFile: method.

- (void) fileTransferServicesSendFileComplete:(OBEXFileTransferServices*)inServices 
        error:(OBEXError)inError; 

Discussion

This method will be called when the transfer operation has finished.

The delegate method for receiving information on the sendFile: transfer

- (void) fileTransferServicesSendFileProgress:(OBEXFileTransferServices*)inServices 
        transferProgress:(NSDictionary*)inProgressDescription; 

Parameters

inProgressDescription

A dictionary containing information on the state of the transfer. The keys to this dictionary are defined in the OBEXFileTransferServicesDelegate category.

Discussion

This method will be called during the transfer operation.

Member Data

NSString value. This key is used with the array of NSDictionary's returned through the delegate method fileTransferServicesGetListingComplete: after calling getFolderListing.

private

extern CFStringRef kFTSListingNameKey; 

Discussion

Int value. This key is used with the array of NSDictionary's returned through the delegate method fileTransferServicesGetListingComplete: after calling getFolderListing.

private

extern CFStringRef kFTSListingSizeKey; 

Discussion

FTSFileType value. This key is used with the array of NSDictionary's returned through the delegate method fileTransferServicesGetListingComplete: after calling getFolderListing.

private

extern CFStringRef kFTSListingTypeKey; 

Discussion

NSNumber integer value. This key is used with the NSDictionary returned from the fileTransferServicesPutProgress: and fileTransferServicesGetProgress: delegate methods

private

extern CFStringRef kFTSProgressBytesTotalKey; 

Discussion

NSNumber integer value. This key is used with the NSDictionary returned from the fileTransferServicesPutProgress: and fileTransferServicesGetProgress: delegate methods

private

extern CFStringRef kFTSProgressBytesTransferredKey; 

Discussion

NSNumber double value. This key is used with the NSDictionary returned from the fileTransferServicesPutProgress: and fileTransferServicesGetProgress: delegate methods

private

extern CFStringRef kFTSProgressEstimatedTimeKey; 

Discussion

NSNumber float value. This key is used with the NSDictionary returned from the fileTransferServicesPutProgress: and fileTransferServicesGetProgress: delegate methods

private

extern CFStringRef kFTSProgressPercentageKey; 

Discussion

NSNumber int value. This key is used with the NSDictionary returned from the fileTransferServicesPutProgress: and fileTransferServicesGetProgress: delegate methods

private

extern CFStringRef kFTSProgressTimeElapsedKey; 

Discussion

NSNumber float value. This key is used with the NSDictionary returned from the fileTransferServicesPutProgress: and fileTransferServicesGetProgress: delegate methods

private

extern CFStringRef kFTSProgressTransferRateKey; 

Discussion

Enumerations

private

enum FTSFileType { 
    kFTSFileTypeFolder = 1, 
    kFTSFileTypeFile = 2 
}; 

Constants

kFTSFileTypeFolder

Folder

kFTSFileTypeFile

File

Discussion

The type values associated with the kFTSListingTypeKey dictionary value

Did this document help you? Yes: Tell us what works for you. It’s good, but: Report typos, inaccuracies, and so forth. It wasn’t helpful: Tell us what would have helped.