OBEXFileTransferServices.h

Overview

Use the links in the table of contents to the left to access the documentation.

Classes

OBEXFileTransferServices

Implements advanced OBEX operations in addition to simple PUT and GET.

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

Discussion

This method will be called during the transfer operation

The delegate method that corresponds to the createFolderNamed: method.

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

Parameters

The delegate method that corresponds to the createFolderNamed: method.

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

Parameters

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

The delegate method that corresponds to the removeItemNamed: method.

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

Parameters

The delegate method that corresponds to the retrieveFolderListing method

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

Parameters

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

Discussion

This method will be called during the transfer operation.

Typedefs

OBEXFileTransferServicesRef

typedef struct OpaqueFileTransferServicesRef * OBEXFileTransferServicesRef;  

Discussion

OBEXFileTransferServices C API is deprecated.

*** DEPRECATED IN BLUETOOTH 2.2 (Mac OS X 10.6) *** You should transition your code to Objective-C equivalents. *** This API may be removed any time in the future.

Globals

kFTSListingNameKey

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

kFTSListingSizeKey

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

kFTSListingTypeKey

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

kFTSProgressBytesTotalKey

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

kFTSProgressBytesTransferredKey

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

kFTSProgressEstimatedTimeKey

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

kFTSProgressPercentageKey

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

kFTSProgressTimeElapsedKey

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

kFTSProgressTransferRateKey

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

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

extern CFStringRef kFTSListingNameKey;  

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

extern CFStringRef kFTSListingSizeKey;  

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

extern CFStringRef kFTSListingTypeKey;  

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

extern CFStringRef kFTSProgressBytesTotalKey;  

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

extern CFStringRef kFTSProgressBytesTransferredKey;  

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

extern CFStringRef kFTSProgressEstimatedTimeKey;  

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

extern CFStringRef kFTSProgressPercentageKey;  

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

extern CFStringRef kFTSProgressTimeElapsedKey;  

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

extern CFStringRef kFTSProgressTransferRateKey;  

Enumerated Types

FTSFileType

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

Constants

Discussion

The type values associated with the kFTSListingTypeKey dictionary value

Last Updated: 2009-10-09