com.citrix.sharefile.api.entities

Class SFGroupsEntity

java.lang.Object

com.citrix.sharefile.api.entities.SFEntitiesBase

com.citrix.sharefile.api.entities.SFGroupsEntity

public class SFGroupsEntity
extends SFEntitiesBase

Field Summary

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

client

Constructor Summary

Constructors

Constructor and Description
SFGroupsEntity(ISFApiClient client)

Method Summary

Methods

Modifier and Type	Method and Description
ISFQuery<SFGroup>	create(SFGroup group) Create Group { "Name":"Name", "IsShared":true, "Contacts":[{"Email":"user.one@domain.com"},{"Email":"user.two@domain.com"}] } Creates a new group.
ISFQuery<SFODataFeed<SFContact>>	createContacts(java.net.URI url, java.util.ArrayList<SFContact> contacts) Add Contacts to Group [{"Email":"user.one@domain.com"},{"Id":"abcd"}] Adds a list of contacts to a group The contact list may contain either contact ID (same as User ID) or Email.
ISFQuery	delete(java.net.URI url) Delete Group Removes a single Group by id
ISFQuery<SFODataFeed<SFContact>>	deleteContacts(java.net.URI url, java.util.ArrayList<SFContact> contacts) Remove Contacts from Group [{"Email":"user.one@domain.com"},{"Id":"abcd"}] Removes contacts from a group The contact list may contain either contact ID (same as User ID) or Email.
ISFQuery<SFODataFeed<SFGroup>>	get() Get Group List Retrieves all Distribution Groups this user has permissions to View in this account
ISFQuery<SFGroup>	get(java.net.URI url) Get Group By ID Retrives a single Group by id
ISFQuery<SFODataFeed<SFContact>>	getContacts(java.net.URI url) Get Group Contacts Retrieves the Contacts navigation property of a Group
ISFQuery<SFGroup>	update(java.net.URI url, SFGroup group) Update Group { "Name":"Name", "IsShared":true, } Updates an existing group.

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

SFGroupsEntity

public SFGroupsEntity(ISFApiClient client)

Method Detail

get

public ISFQuery<SFODataFeed<SFGroup>> get()

Get Group List Retrieves all Distribution Groups this user has permissions to View in this account

Returns:

a list of Groups this user has access to

get

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

Get Group By ID Retrives a single Group by id

Parameters:

url -

Returns:

A single Group object

Throws:

InvalidOrMissingParameterException

delete

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

Delete Group Removes a single Group by id

Parameters:

url -

Throws:

InvalidOrMissingParameterException

create

public ISFQuery<SFGroup> create(SFGroup group)
                         throws InvalidOrMissingParameterException

Create Group { "Name":"Name", "IsShared":true, "Contacts":[{"Email":"user.one@domain.com"},{"Email":"user.two@domain.com"}] } Creates a new group. The Post body must include the specification of the group.

Parameters:

group -

Returns:

the new group instance

Throws:

InvalidOrMissingParameterException

update

public ISFQuery<SFGroup> update(java.net.URI url,
                       SFGroup group)
                         throws InvalidOrMissingParameterException

Update Group { "Name":"Name", "IsShared":true, } Updates an existing group. This operation will ignore the provided clients list. Use the \Contacts navigation link to add/remove elements from a group

Parameters:

url -

group -

Returns:

the modified group object

Throws:

InvalidOrMissingParameterException

getContacts

public ISFQuery<SFODataFeed<SFContact>> getContacts(java.net.URI url)
                                             throws InvalidOrMissingParameterException

Get Group Contacts Retrieves the Contacts navigation property of a Group

Parameters:

url -

Returns:

A feed of Contacts representing the members of the Group

Throws:

InvalidOrMissingParameterException

createContacts

public ISFQuery<SFODataFeed<SFContact>> createContacts(java.net.URI url,
                                              java.util.ArrayList<SFContact> contacts)
                                                throws InvalidOrMissingParameterException

Add Contacts to Group [{"Email":"user.one@domain.com"},{"Id":"abcd"}] Adds a list of contacts to a group The contact list may contain either contact ID (same as User ID) or Email.

Parameters:

url -

contacts -

Returns:

The updated list of contacts for this group

Throws:

InvalidOrMissingParameterException

deleteContacts

public ISFQuery<SFODataFeed<SFContact>> deleteContacts(java.net.URI url,
                                              java.util.ArrayList<SFContact> contacts)
                                                throws InvalidOrMissingParameterException

Remove Contacts from Group [{"Email":"user.one@domain.com"},{"Id":"abcd"}] Removes contacts from a group The contact list may contain either contact ID (same as User ID) or Email. This method will ignore missing references in the provided list - i.e., if an email in the contacts list is not present in the group, it will be ignored. The method will not enforce that ID and Email match inside a single Contact instance: Id will be looked up first, then Email.

Parameters:

url -

contacts -

Returns:

The updated list of contacts for this group

Throws:

InvalidOrMissingParameterException