com.citrix.sharefile.api.entities

Class SFFavoriteFoldersEntity

java.lang.Object

com.citrix.sharefile.api.entities.SFEntitiesBase

com.citrix.sharefile.api.entities.SFFavoriteFoldersEntity

public class SFFavoriteFoldersEntity
extends SFEntitiesBase

Field Summary

Fields inherited from class com.citrix.sharefile.api.entities.SFEntitiesBase

client

Constructor Summary

Constructors

Constructor and Description
SFFavoriteFoldersEntity(ISFApiClient client)

Method Summary

Methods

Modifier and Type	Method and Description
ISFQuery<SFFavoriteFolder>	createByUser(java.net.URI url, SFFavoriteFolder folder) Create FavoriteFolder { "Folder": { "Id":"fo96aec5-d637-4124-bcc9-c86fd7301e4d" }, "FolderAlias" : "alias" } Adds an existing folder to the list of favorites of a given user.
ISFQuery	delete(java.net.URI url, java.lang.String itemid) Delete FavoriteFolder Removes a favorite folder from a user's list.
ISFQuery	deleteByUser(java.net.URI url, java.lang.String itemId)
ISFQuery<SFFavoriteFolder>	get(java.net.URI url) Get FavoriteFolder Retrieve a single Favorite Folder from a give user
ISFQuery<SFODataFeed<SFFavoriteFolder>>	getByUser(java.net.URI url) Get List of FavoriteFolders Retrieves the list of Favorite folders for a given user.
ISFQuery<SFFavoriteFolder>	getByUser(java.net.URI itemUrl, java.lang.String userid) Get FavoriteFolder Retrieves a single Favorite Folder
ISFQuery<SFFavoriteFolder>	getFavoriteFolderByItem(java.net.URI parentUrl) Get Item as Favorite Folder Retrieves a Favorite Folder representation of a given parent Item

Methods inherited from class com.citrix.sharefile.api.entities.SFEntitiesBase

getEntity

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SFFavoriteFoldersEntity

public SFFavoriteFoldersEntity(ISFApiClient client)

Method Detail

getByUser

public ISFQuery<SFODataFeed<SFFavoriteFolder>> getByUser(java.net.URI url)
                                                  throws InvalidOrMissingParameterException

Get List of FavoriteFolders Retrieves the list of Favorite folders for a given user.

Parameters:

url -

Returns:

A list of Favorite Folders specified by this user

Throws:

InvalidOrMissingParameterException

getByUser

public ISFQuery<SFFavoriteFolder> getByUser(java.net.URI itemUrl,
                                   java.lang.String userid)
                                     throws InvalidOrMissingParameterException

Get FavoriteFolder Retrieves a single Favorite Folder

Parameters:

itemUrl -

Returns:

A list of Favorite Folders specified by this user

Throws:

InvalidOrMissingParameterException

getFavoriteFolderByItem

public ISFQuery<SFFavoriteFolder> getFavoriteFolderByItem(java.net.URI parentUrl)
                                                   throws InvalidOrMissingParameterException

Get Item as Favorite Folder Retrieves a Favorite Folder representation of a given parent Item

Parameters:

parentUrl -

Returns:

The specified Favorite Folder if it belongs to the specified parent Item

Throws:

InvalidOrMissingParameterException

get

public ISFQuery<SFFavoriteFolder> get(java.net.URI url)
                               throws InvalidOrMissingParameterException

Get FavoriteFolder Retrieve a single Favorite Folder from a give user

Returns:

The selected Favorite Folder

Throws:

InvalidOrMissingParameterException

createByUser

public ISFQuery<SFFavoriteFolder> createByUser(java.net.URI url,
                                      SFFavoriteFolder folder)
                                        throws InvalidOrMissingParameterException

Create FavoriteFolder { "Folder": { "Id":"fo96aec5-d637-4124-bcc9-c86fd7301e4d" }, "FolderAlias" : "alias" } Adds an existing folder to the list of favorites of a given user.

Parameters:

url -

folder -

Returns:

A new FavoriteFolder record

Throws:

InvalidOrMissingParameterException

delete

public ISFQuery delete(java.net.URI url,
              java.lang.String itemid)
                throws InvalidOrMissingParameterException

Delete FavoriteFolder Removes a favorite folder from a user's list.

Parameters:

url -

Throws:

InvalidOrMissingParameterException

deleteByUser

public ISFQuery deleteByUser(java.net.URI url,
                    java.lang.String itemId)
                      throws InvalidOrMissingParameterException

Throws:

InvalidOrMissingParameterException