binder_uploadFile

Syntax

public void binder_uploadFile( String accessToken, long binderId, String formDataItemName, String fileName );

Description

The binder_uploadFile operation performs an action equivalent to using the UI to upload a file to either a workspace or folder. You can attach only one file at a time; call this operation multiple times to attach more than one file to the binder.

By default, workspaces do not include attached files. However, users can use the designers to define workspaces that do include attached files.

Parameters and Return Value

accessToken

Either the security token passed to your application by Vibe as part of implementing a remote application, or the null value.

binderId

The binder identifier for the workspace or folder into which you want to upload a file.

formDataItemname

A string containing the internal identifier for the part of the entry that contains attached files. This identifier maps the name attribute of an input HTML tag on a form to data in the Vibe database; a hidden HTML tag communicates this file mapping to the server.

The name value for the standard entry element containing attached files is ss_attachFile. If you want to upload a file into a custom form element you defined using the designers, you need to look up the name identifier for that form element.

If you are uploading to a folder file, specify upload as an argument to this parameter to make this attachment the primary file for the entry.

fileName

A string containing the filename of the file you want to upload to the binder.

return_value

None.

See Also