com.citrix.sharefile.api.entities

Class SFFolderTemplatesEntity

java.lang.Object

com.citrix.sharefile.api.entities.SFEntitiesBase

com.citrix.sharefile.api.entities.SFFolderTemplatesEntity

public class SFFolderTemplatesEntity
extends SFEntitiesBase

Field Summary

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

client

Constructor Summary

Constructors

Constructor and Description
SFFolderTemplatesEntity(ISFApiClient client)

Method Summary

Methods

Modifier and Type	Method and Description
ISFQuery<SFFolderTemplate>	create(SFFolderTemplate template) Create Folder Template { "Name": "Client Folder", "Description": "For all client folders created in 2014 or after" "Items": [ { "Name": "Folder 1", "Items": [ { "Name": "Subfolder1" } ] }, { "Name": "Folder 2" } ] Creates a new folder template.
ISFQuery	delete(java.net.URI url) Delete Folder Template Removes a folder template
ISFQuery<SFODataFeed<SFFolderTemplate>>	get() Get Folder Templates for Current Account Returns all folder templates for the current account.
ISFQuery<SFFolderTemplate>	get(java.net.URI url)
ISFQuery<SFFolderTemplate>	update(SFFolderTemplate template) Update Folder Template { "Name": "Client Folder", "Description": "For all client folders created in 2014 or after", "Items": [ { "Name": "A new folder", "Items": [ { "TemplateId": "ft-12345-abdef-abdef-12345-abdef", "Name": "A new subfolder" } ] }, { "Id": "fti-xxxxx-xxxxx-xxxxx-xxxxx", "Name": "An existing folder with a different name" } ] } Updates an existing folder template

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

SFFolderTemplatesEntity

public SFFolderTemplatesEntity(ISFApiClient client)

Method Detail

get

public ISFQuery<SFODataFeed<SFFolderTemplate>> get()

Get Folder Templates for Current Account Returns all folder templates for the current account.

Returns:

Folder templates for current account

get

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

Throws:

InvalidOrMissingParameterException

create

public ISFQuery<SFFolderTemplate> create(SFFolderTemplate template)
                                  throws InvalidOrMissingParameterException

Create Folder Template { "Name": "Client Folder", "Description": "For all client folders created in 2014 or after" "Items": [ { "Name": "Folder 1", "Items": [ { "Name": "Subfolder1" } ] }, { "Name": "Folder 2" } ] Creates a new folder template.

Returns:

The created folder template

Throws:

InvalidOrMissingParameterException

update

public ISFQuery<SFFolderTemplate> update(SFFolderTemplate template)
                                  throws InvalidOrMissingParameterException

Update Folder Template { "Name": "Client Folder", "Description": "For all client folders created in 2014 or after", "Items": [ { "Name": "A new folder", "Items": [ { "TemplateId": "ft-12345-abdef-abdef-12345-abdef", "Name": "A new subfolder" } ] }, { "Id": "fti-xxxxx-xxxxx-xxxxx-xxxxx", "Name": "An existing folder with a different name" } ] } Updates an existing folder template

Returns:

The updated folder template

Throws:

InvalidOrMissingParameterException

delete

public ISFQuery delete(java.net.URI url)
                throws InvalidOrMissingParameterException

Delete Folder Template Removes a folder template

Parameters:

url -

Throws:

InvalidOrMissingParameterException