menu_request_set_file_transfer_mode()

#include "bps/menu.h"
 

BPS_API int menu_request_set_file_transfer_mode(menu_request_t *request,
                                                navigator_invoke_file_transfer_mode_t transfer_mode)

Since:

BlackBerry 10.0.0

Arguments:

request

The request to update.

transfer_mode

The file transfer mode that is applied to the invocation.

Library:

libbps (For the qcc command, use the -l bps option to link against this library)

Description:

The menu_request_set_file_transfer_mode() function sets the transfer mode for the associated file URI value. The file transfer mode allows the sender to control how data files are transferred between the sender and the target. File transfer handling applies only to file URI values that refer to files that are not in the share area.

By default, such files are copied as read-only into the target's private inbox. Using a file transfer mode, senders can change this behavior to skip private file transfer and deliver the specified file URI or copy the file read-write, or create a link to the file.

When creating a link to the file, the file permissions must allow the application owner to have read access (o+r). In addition, if the file permissions are set to the application owner having write access (o+w), then the sender must be the file owner for NAVIGATOR_INVOKE_FILE_TRANSFER_MODE_LINK mode to succeed.

Returns:

BPS_SUCCESS upon success, BPS_FAILURE with errno set otherwise.