navigator_invoke_invocation_set_file_transfer_mode()

#include <bps/navigator_invoke.h>
 

BPS_API int navigator_invoke_invocation_set_file_transfer_mode(navigator_invoke_invocation_t *invoke,
                                                               navigator_invoke_file_transfer_mode_t transfer_mode)

Since:

BlackBerry 10.0.0

Arguments:

invoke

A pointer to the navigator_invoke_invocation_t structure whose transfer_mode member you want to set.

transfer_mode

The mode that should control the transfer of the data if the URI is a file URI that does not refer to a file in the shared area.

Library:

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

Description:

The navigator_invoke_invocation_set_file_transfer_mode() function sets the file transfer mode.

The transfer_mode identifies how the file transfer should be handled. By default, private file transfer will be applied if the URI is a file URI that points to a file that is not in the shared area. The file will be transfered by creating a read-only copy in the target's private inbox.

Setting the transfer_mode allows the sender to control the transfer by specifying that no handling should be applied, or that the file should be copied read/write, or should be hard-linked.

If NAVIGATOR_INVOKE_FILE_TRANSFER_MODE_LINK is specified the file must have o+r permissions. In addition, if the file is o+w then the sender must be the owner of the file.

Returns:

BPS_SUCCESS upon success, BPS_FAILURE with errno set otherwise.