| addTransfer
|
Adds a transfer definition to the system.
The file ID is returned if method successful or null if failed.
The user calling this method must have UpdateTransferDefinitionRight or AdministratorRight.
|
| updateTransfer
|
Updates a transfer definition in the system.
The user calling this method must have UpdateTransferDefinitionRight or AdministratorRight.
Note: When performing an update, only set the fields that you want to update in the transfer object. The rest of the fields will be null.
To update a field to become null:
- String objects should be set to be an empty string (for example: "").
- The members of DateTime objects should be set to zero.
|
| removeTransfer
|
Removes a transfer definition from the system.
The user calling this method must have UpdateTransferDefinitionRight or AdministratorRight.
|
| removeExpiredTransfers
|
Removes an expired transfer definitions from the system.
A transfer definition is considered expired if the current date passes the expiration date of the transfer definition.
The user calling this method must have UpdateTransferDefinitionRight or AdministratorRight.
|
| retrieveAllTransfers
|
Retrieves all transfer definitions from the system as an array of transfers.
The last element of the array is null. If no transfers are found, an array of one element is returned with a value of null. This method returns 100 transfer definitions at a time, you must keep track of the last transfer ID returned if you want to get the next 100 transfer definitions. The first time you call this method, pass in empty string for lastTransferId.
The user calling this method must have ViewTransferDefinitionRight, UpdateTransferDefinitionRight, or AdministratorRight.
|
| retrieveAllExpiredTransfers
|
Retrieves all expired transfer definitions from the system as an array of transfers.
A transfer definition is considered expired if the current date passes the expiration date of the transfer definition. The last element of the array is null. If no transfers are found, an array of one element is returned with a value of null. This method returns 100 files at a time, you must keep track of the last file ID returned if you want to get the next 100 files. The first time you call this method, pass in empty string for lastTransferId.
The user calling this method must have ViewTransferDefinitionRight, UpdateTransferDefinitionRight, or AdministratorRight.
|
| getTransfer
|
Gets a transfer from the system.
If the transfer is not found, a null is returned.
The user calling this method must have ViewTransferDefinitionRight, UpdateTransferDefinitionRight, or AdministratorRight.
|
|
retrieveAllTransfersForUser
|
Retrieves all transfer definitions that a user can transfer in the system as an array of transfers.
Users can transfer definitions that have the authorized user ID set to an ID or the authorized group ID set to a group that they are a member of. The last element of the array is null. If no transfers are found, an array of one element is returned with a value of null. This method returns 100 files at a time, you must keep track of the last transfer ID returned if you want to get the next 100 transfer definitions. The first time you call this method, pass in empty string for lastTransferId.
The user calling this method must have ViewTransferDefinitionRight, UpdateTransferDefinitionRight, or AdministratorRight.
|
| searchTransfers
|
Retrieves all transfer definitions that match the search criteria specified in the transfer object.
Searches are only done on the following fields:
- File Id
-
Client File Name
-
Server File Name
-
File Description
-
Authorized User Id
-
Authorized Group Id
-
Node Name
Set the fields in the Transfer object that you want to search on. All other fields will be ignored. You can set from one to all the fields. Use the percent sign (%) as a wildcard character. The results are returned as an array of transfer objects. The last element of the array is null. If no transfers are found, an array of one element is returned with a value of null. This method returns 100 files at a time, you must keep track of the last file ID returned if you want to get the next 100 files. The first time you call this method, pass in empty string for lastTransferId.
The user calling this method must have ViewTransferDefinitionRight, UpdateTransferDefinitionRight, or AdministratorRight.
|
