Login Login
Sign Up Login
REST API SOAP API My Application

createNewFolder

public long createNewFolder(java.lang.String login,
 java.lang.String password,
 long dirID,
 java.lang.String folderName)

Creates new folder as dirId subfolder.

Parameters:

login - user login
password - user password
dirID - id of the directory to create folder in
folderName - new folder name

Returns:

0 - if creation denied, newly created dir ID otherwise
-1 - already exists
-2 - attempt to create folder in removed parent

setDirDescription

java.lang.String setDirDescription(java.lang.String login,
 java.lang.String password,
 long dirId,
 java.lang.String newDescription,
 boolean setAsDefault,
 boolean applyToAll)

Sets folder description for dedicated folder or account as a whole.

getDirDescription

java.lang.String getDirDescription(java.lang.String login,
 java.lang.String password,
 long dirId)

Returns folder description.

renameFolder

public long renameFolder(java.lang.String login,
 java.lang.String password,
 long dirID,
 java.lang.String newName)

Renames specified folder.

Parameters:

login - user login
password - user password
dirID - id of folder to be ename
newName - new name of folder

Returns:

-1 if file exists,
0 in case of other failures,
dirID if rename was successful

deleteFolder

public void deleteFolder(java.lang.String login,
 java.lang.String password,
 long dirID)

Completely removes folder and puts all of it contents to recycle bin.

Parameters:

login - user login
password - user password
dirID - id of the directory to be removed

deleteFolderFinal

void deleteFolderFinal(java.lang.String login,
java.lang.String password,
long dirID)

Removes files and subfolders from recycle bin.

emptyRecycleBin

int emptyRecycleBin(java.lang.String login,
 java.lang.String password)

Empties recycle bean for specified user.

getDirInfo

public com.pmstation.shared.soap.api.AccountItem getDirInfo(java.lang.String login,
 java.lang.String password,
 long dirID)

Return info about specified folder.

Parameters:

login - user login
password - user password
dirID - id of the folder

Returns:

folder info

getRoot

AccountItem getRoot(java.lang.String login,
 java.lang.String password)

Returns account item for user's root directory.

getAllFolders

public com.pmstation.shared.soap.api.AccountItem[] getAllFolders(java.lang.String login,
 java.lang.String password)

Returns all of the folders in user's root directory.

Parameters:

login - user login
password - user password

Returns:

Array of info records about user's root folder subfolders

getHistory

public com.pmstation.shared.soap.common.DirHistoryDTO[] getHistory(java.lang.String login,
 java.lang.String password,
 long dirId)

Returns history of operations in specified folder and subfolders. For operation field meanings see getOperationDescriptions().

Parameters:

login - user login
password - user password
dirId - id of folder

Returns:

Array of folder changes. May be null or empty

getHistoryFromId

public com.pmstation.shared.soap.common.DirHistoryDTO[] getHistoryFromId(java.lang.String login,
 java.lang.String password,
 long dirId,
 long fromId)

Returns history of operations which occurs in specified folder and subfolders with history id more then specified. For operation field meanings see getOperationDescriptions().

Parameters:

login - user login
password - user password
dirId - id of folder to take history for
fromId - id floor of history

Returns:

Array of folder changes. May be null or empty

markSynchronized

public void markSynchronized(java.lang.String login,
 java.lang.String password,
 long dirId)

Informs 4sync to write folder and subfolders usage history.

Parameters:

login - user login
password - user password
dirId - id of folder to write history for

getOperationDescriptions

public java.lang.String[] getOperationDescriptions()

Returns array of OperationEnum names. Array index corresponds to values which can be returned as DirHistoryDTO.getOperation(). Array is supposed to be zero-based.

Returns:

array of OperationEnum names