com.citrix.sharefile.api.entities

Class SFUsersEntity

java.lang.Object

com.citrix.sharefile.api.entities.SFEntitiesBase

com.citrix.sharefile.api.entities.SFUsersEntity

public class SFUsersEntity
extends SFEntitiesBase

Field Summary

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

client

Constructor Summary

Constructors

Constructor and Description
SFUsersEntity(ISFApiClient client)

Method Summary

Methods

Modifier and Type	Method and Description
ISFQuery<SFODataFeed<SFItem>>	box(java.net.URI url) Get User's FileBox children
ISFQuery	confirm(SFUserConfirmationSettings settings) Confirm the current user logging in for the first time { "FirstName":"", "LastName":"", "Company":"", "Password":"", "SecurityQuestion":"", "SecurityQuestionAnswer":"", "DayLightName":"", "UTCOffset":"", "DateFormat":"", "TimeFormat":"", "EmailInterval":0 }
ISFQuery<SFUser>	create(SFUser user) Create Client User { "Email":"user.one@domain.com", "FirstName":"Name", "LastName":"Last Name", "Company":"Company", "Password":"password", "Preferences": { "CanResetPassword":true, "CanViewMySettings":true }, "DefaultZone": { "Id":"zoneid" } } Creates a new Client User and associates it to an Account The following parameters from the input object are used: Email, FirstName, LastName, Company, DefaultZone, Password, Preferences.CanResetPassword and Preferences.CanViewMySettingsOther parameters are ignored
ISFQuery<SFUser>	create(SFUser user, java.lang.Boolean pushCreatorDefaultSettings) Create Client User { "Email":"user.one@domain.com", "FirstName":"Name", "LastName":"Last Name", "Company":"Company", "Password":"password", "Preferences": { "CanResetPassword":true, "CanViewMySettings":true }, "DefaultZone": { "Id":"zoneid" } } Creates a new Client User and associates it to an Account The following parameters from the input object are used: Email, FirstName, LastName, Company, DefaultZone, Password, Preferences.CanResetPassword and Preferences.CanViewMySettingsOther parameters are ignored
ISFQuery<SFUser>	create(SFUser user, java.lang.Boolean pushCreatorDefaultSettings, java.lang.Boolean addshared) Create Client User { "Email":"user.one@domain.com", "FirstName":"Name", "LastName":"Last Name", "Company":"Company", "Password":"password", "Preferences": { "CanResetPassword":true, "CanViewMySettings":true }, "DefaultZone": { "Id":"zoneid" } } Creates a new Client User and associates it to an Account The following parameters from the input object are used: Email, FirstName, LastName, Company, DefaultZone, Password, Preferences.CanResetPassword and Preferences.CanViewMySettingsOther parameters are ignored
ISFQuery<SFUser>	create(SFUser user, java.lang.Boolean pushCreatorDefaultSettings, java.lang.Boolean addshared, java.lang.Boolean notify) Create Client User { "Email":"user.one@domain.com", "FirstName":"Name", "LastName":"Last Name", "Company":"Company", "Password":"password", "Preferences": { "CanResetPassword":true, "CanViewMySettings":true }, "DefaultZone": { "Id":"zoneid" } } Creates a new Client User and associates it to an Account The following parameters from the input object are used: Email, FirstName, LastName, Company, DefaultZone, Password, Preferences.CanResetPassword and Preferences.CanViewMySettingsOther parameters are ignored
ISFQuery<SFUser>	create(SFUser user, java.lang.Boolean pushCreatorDefaultSettings, java.lang.Boolean addshared, java.lang.Boolean notify, java.lang.Boolean ifNecessary) Create Client User { "Email":"user.one@domain.com", "FirstName":"Name", "LastName":"Last Name", "Company":"Company", "Password":"password", "Preferences": { "CanResetPassword":true, "CanViewMySettings":true }, "DefaultZone": { "Id":"zoneid" } } Creates a new Client User and associates it to an Account The following parameters from the input object are used: Email, FirstName, LastName, Company, DefaultZone, Password, Preferences.CanResetPassword and Preferences.CanViewMySettingsOther parameters are ignored
ISFQuery<SFUser>	create(SFUser user, java.lang.Boolean pushCreatorDefaultSettings, java.lang.Boolean addshared, java.lang.Boolean notify, java.lang.Boolean ifNecessary, java.lang.Boolean addPersonal) Create Client User { "Email":"user.one@domain.com", "FirstName":"Name", "LastName":"Last Name", "Company":"Company", "Password":"password", "Preferences": { "CanResetPassword":true, "CanViewMySettings":true }, "DefaultZone": { "Id":"zoneid" } } Creates a new Client User and associates it to an Account The following parameters from the input object are used: Email, FirstName, LastName, Company, DefaultZone, Password, Preferences.CanResetPassword and Preferences.CanViewMySettingsOther parameters are ignored
ISFQuery<SFUser>	createAccountUser(SFAccountUser user) Create Employee { "Email":"user.one@domain.com", "FirstName":"Name", "LastName":"Last Name", "Company":"Company", "Password":"password", "StorageQuotaLimitGB":50, "Preferences": { "CanResetPassword":true, "CanViewMySettings":true }, "DefaultZone": { "Id":"zoneid" }, "IsAdministrator": false, "CanCreateFolders": false, "CanUseFileBox": true, "CanManageUsers": false, "Roles": [ "CanChangePassword", "CanManageMySettings", "CanUseFileBox, "CanManageUsers, "CanCreateFolders, "CanUseDropBox, "CanSelectFolderZone, "AdminAccountPolicies", "AdminBilling", "AdminBranding", "AdminChangePlan", "AdminFileBoxAccess", "AdminManageEmployees", "AdminRemoteUploadForms", "AdminReporting", "AdminSharedDistGroups", "AdminSharedAddressBook", "AdminViewReceipts", "AdminDelegate", "AdminManageFolderTemplates", "AdminEmailMessages", "AdminSSO", "AdminSuperGroup", "AdminZones", "AdminCreateSharedGroups", "AdminConnectors" ] } Creates a new Employee User (AccountUser) and associates it to an Account The following parameters from the input object are used: Email, FirstName, LastName, Company, DefaultZone, Password, IsEmployee, IsAdministrator, CanCreateFolders, CanUseFileBox, CanManageUsers, Preferences.CanResetPassword and Preferences.CanViewMySettings.
ISFQuery<SFUser>	createAccountUser(SFAccountUser user, java.lang.Boolean pushCreatorDefaultSettings) Create Employee { "Email":"user.one@domain.com", "FirstName":"Name", "LastName":"Last Name", "Company":"Company", "Password":"password", "StorageQuotaLimitGB":50, "Preferences": { "CanResetPassword":true, "CanViewMySettings":true }, "DefaultZone": { "Id":"zoneid" }, "IsAdministrator": false, "CanCreateFolders": false, "CanUseFileBox": true, "CanManageUsers": false, "Roles": [ "CanChangePassword", "CanManageMySettings", "CanUseFileBox, "CanManageUsers, "CanCreateFolders, "CanUseDropBox, "CanSelectFolderZone, "AdminAccountPolicies", "AdminBilling", "AdminBranding", "AdminChangePlan", "AdminFileBoxAccess", "AdminManageEmployees", "AdminRemoteUploadForms", "AdminReporting", "AdminSharedDistGroups", "AdminSharedAddressBook", "AdminViewReceipts", "AdminDelegate", "AdminManageFolderTemplates", "AdminEmailMessages", "AdminSSO", "AdminSuperGroup", "AdminZones", "AdminCreateSharedGroups", "AdminConnectors" ] } Creates a new Employee User (AccountUser) and associates it to an Account The following parameters from the input object are used: Email, FirstName, LastName, Company, DefaultZone, Password, IsEmployee, IsAdministrator, CanCreateFolders, CanUseFileBox, CanManageUsers, Preferences.CanResetPassword and Preferences.CanViewMySettings.
ISFQuery<SFUser>	createAccountUser(SFAccountUser user, java.lang.Boolean pushCreatorDefaultSettings, java.lang.Boolean addshared) Create Employee { "Email":"user.one@domain.com", "FirstName":"Name", "LastName":"Last Name", "Company":"Company", "Password":"password", "StorageQuotaLimitGB":50, "Preferences": { "CanResetPassword":true, "CanViewMySettings":true }, "DefaultZone": { "Id":"zoneid" }, "IsAdministrator": false, "CanCreateFolders": false, "CanUseFileBox": true, "CanManageUsers": false, "Roles": [ "CanChangePassword", "CanManageMySettings", "CanUseFileBox, "CanManageUsers, "CanCreateFolders, "CanUseDropBox, "CanSelectFolderZone, "AdminAccountPolicies", "AdminBilling", "AdminBranding", "AdminChangePlan", "AdminFileBoxAccess", "AdminManageEmployees", "AdminRemoteUploadForms", "AdminReporting", "AdminSharedDistGroups", "AdminSharedAddressBook", "AdminViewReceipts", "AdminDelegate", "AdminManageFolderTemplates", "AdminEmailMessages", "AdminSSO", "AdminSuperGroup", "AdminZones", "AdminCreateSharedGroups", "AdminConnectors" ] } Creates a new Employee User (AccountUser) and associates it to an Account The following parameters from the input object are used: Email, FirstName, LastName, Company, DefaultZone, Password, IsEmployee, IsAdministrator, CanCreateFolders, CanUseFileBox, CanManageUsers, Preferences.CanResetPassword and Preferences.CanViewMySettings.
ISFQuery<SFUser>	createAccountUser(SFAccountUser user, java.lang.Boolean pushCreatorDefaultSettings, java.lang.Boolean addshared, java.lang.Boolean notify) Create Employee { "Email":"user.one@domain.com", "FirstName":"Name", "LastName":"Last Name", "Company":"Company", "Password":"password", "StorageQuotaLimitGB":50, "Preferences": { "CanResetPassword":true, "CanViewMySettings":true }, "DefaultZone": { "Id":"zoneid" }, "IsAdministrator": false, "CanCreateFolders": false, "CanUseFileBox": true, "CanManageUsers": false, "Roles": [ "CanChangePassword", "CanManageMySettings", "CanUseFileBox, "CanManageUsers, "CanCreateFolders, "CanUseDropBox, "CanSelectFolderZone, "AdminAccountPolicies", "AdminBilling", "AdminBranding", "AdminChangePlan", "AdminFileBoxAccess", "AdminManageEmployees", "AdminRemoteUploadForms", "AdminReporting", "AdminSharedDistGroups", "AdminSharedAddressBook", "AdminViewReceipts", "AdminDelegate", "AdminManageFolderTemplates", "AdminEmailMessages", "AdminSSO", "AdminSuperGroup", "AdminZones", "AdminCreateSharedGroups", "AdminConnectors" ] } Creates a new Employee User (AccountUser) and associates it to an Account The following parameters from the input object are used: Email, FirstName, LastName, Company, DefaultZone, Password, IsEmployee, IsAdministrator, CanCreateFolders, CanUseFileBox, CanManageUsers, Preferences.CanResetPassword and Preferences.CanViewMySettings.
ISFQuery<SFUser>	createAccountUser(SFAccountUser user, java.lang.Boolean pushCreatorDefaultSettings, java.lang.Boolean addshared, java.lang.Boolean notify, java.lang.Boolean ifNecessary) Create Employee { "Email":"user.one@domain.com", "FirstName":"Name", "LastName":"Last Name", "Company":"Company", "Password":"password", "StorageQuotaLimitGB":50, "Preferences": { "CanResetPassword":true, "CanViewMySettings":true }, "DefaultZone": { "Id":"zoneid" }, "IsAdministrator": false, "CanCreateFolders": false, "CanUseFileBox": true, "CanManageUsers": false, "Roles": [ "CanChangePassword", "CanManageMySettings", "CanUseFileBox, "CanManageUsers, "CanCreateFolders, "CanUseDropBox, "CanSelectFolderZone, "AdminAccountPolicies", "AdminBilling", "AdminBranding", "AdminChangePlan", "AdminFileBoxAccess", "AdminManageEmployees", "AdminRemoteUploadForms", "AdminReporting", "AdminSharedDistGroups", "AdminSharedAddressBook", "AdminViewReceipts", "AdminDelegate", "AdminManageFolderTemplates", "AdminEmailMessages", "AdminSSO", "AdminSuperGroup", "AdminZones", "AdminCreateSharedGroups", "AdminConnectors" ] } Creates a new Employee User (AccountUser) and associates it to an Account The following parameters from the input object are used: Email, FirstName, LastName, Company, DefaultZone, Password, IsEmployee, IsAdministrator, CanCreateFolders, CanUseFileBox, CanManageUsers, Preferences.CanResetPassword and Preferences.CanViewMySettings.
ISFQuery<SFUser>	createAccountUser(SFAccountUser user, java.lang.Boolean pushCreatorDefaultSettings, java.lang.Boolean addshared, java.lang.Boolean notify, java.lang.Boolean ifNecessary, java.lang.Boolean addPersonal) Create Employee { "Email":"user.one@domain.com", "FirstName":"Name", "LastName":"Last Name", "Company":"Company", "Password":"password", "StorageQuotaLimitGB":50, "Preferences": { "CanResetPassword":true, "CanViewMySettings":true }, "DefaultZone": { "Id":"zoneid" }, "IsAdministrator": false, "CanCreateFolders": false, "CanUseFileBox": true, "CanManageUsers": false, "Roles": [ "CanChangePassword", "CanManageMySettings", "CanUseFileBox, "CanManageUsers, "CanCreateFolders, "CanUseDropBox, "CanSelectFolderZone, "AdminAccountPolicies", "AdminBilling", "AdminBranding", "AdminChangePlan", "AdminFileBoxAccess", "AdminManageEmployees", "AdminRemoteUploadForms", "AdminReporting", "AdminSharedDistGroups", "AdminSharedAddressBook", "AdminViewReceipts", "AdminDelegate", "AdminManageFolderTemplates", "AdminEmailMessages", "AdminSSO", "AdminSuperGroup", "AdminZones", "AdminCreateSharedGroups", "AdminConnectors" ] } Creates a new Employee User (AccountUser) and associates it to an Account The following parameters from the input object are used: Email, FirstName, LastName, Company, DefaultZone, Password, IsEmployee, IsAdministrator, CanCreateFolders, CanUseFileBox, CanManageUsers, Preferences.CanResetPassword and Preferences.CanViewMySettings.
ISFQuery	delete(java.net.URI url) Delete User Removes an user
ISFQuery	delete(java.net.URI url, java.lang.Boolean completely) Delete User Removes an user
ISFQuery<SFUser>	deleteEmailAddress(java.lang.String email) Delete the email address from user
ISFQuery<SFItem>	fileBox(java.net.URI url) Get User's FileBox folder
ISFQuery	forgotPassword(java.lang.String email) Forgot Password Triggers a reset password email
ISFQuery	forgotPassword(java.lang.String email, java.lang.Boolean resetOnMobile) Forgot Password Triggers a reset password email
ISFQuery<SFUser>	get() Get User Retrieve a single user, by ID or email, or the currently authenticated user.
ISFQuery<SFUser>	get(java.lang.String id) Get User Retrieve a single user, by ID or email, or the currently authenticated user.
ISFQuery<SFUser>	get(java.lang.String id, java.lang.String emailAddress) Get User Retrieve a single user, by ID or email, or the currently authenticated user.
ISFQuery<SFODataFeed<SFItem>>	getAllSharedFolders() Get List of User Shared Folders Retrieve the list of shared folders the authenticated user has access to
ISFQuery<SFItem>	getHomeFolder(java.net.URI url) Get HomeFolder Returns a user's home folder
ISFQuery<SFODataFeed<SFShare>>	getInbox(java.net.URI url) Get Inbox for Recipient Retrieve all outstanding Shares in the inbox.User identifier
ISFQuery<SFODataFeed<SFShare>>	getInbox(java.net.URI url, SFSafeEnum<SFShareType> type) Get Inbox for Recipient Retrieve all outstanding Shares in the inbox.User identifier
ISFQuery<SFODataFeed<SFShare>>	getInbox(java.net.URI url, SFSafeEnum<SFShareType> type, java.lang.Boolean archived) Get Inbox for Recipient Retrieve all outstanding Shares in the inbox.User identifier
ISFQuery<SFUserInfo>	getInfo() Get Current User Info
ISFQuery<SFUserPreferences>	getPreferences(java.net.URI url) Get User Preferences Retrieves the User preferences record - all user-selected prefernces, such as timezone, time format, sort preferences, etc.
ISFQuery<SFUserSecurity>	getSecurity(java.net.URI url) Get User Security Retrieve the user security record - current state of the user regarding security and password settings.
ISFQuery<SFODataFeed<SFItem>>	getTopFolders() Get List of User Shared Folders Retrieve the top-level folders for this user.
ISFQuery<SFODataFeed<SFItem>>	getTopFolders(java.net.URI url) Get User's top Folder
ISFQuery<SFInboxMetadata>	inboxMetadata(java.net.URI url) Get Inbox Metadata Returns metadata of the inbox.User identifier
ISFQuery<SFUser>	makePrimary(java.lang.String email) Set email address as the primary email address for CURRENT user
ISFQuery<SFODataFeed<SFItem>>	networkShareConnectors() Get List of User Shared Folders Retrieve the connector folders that are associated with a network share service
ISFQuery<SFUser>	patchRoles(java.net.URI parentUrl, SFUser user) Set Roles { "Roles" : [ "CanManageUsers", "CanSelectFolderZone" ] } Sets the roles for a user (roles not provided will be disabled.) The following roles can be set to the user through this call (depending on User type): CanCreateFolders, CanSelectFolderZone, CanUseFileBox, CanManageUsers, AdminSharedAddressBook, CanChangePassword, CanManageMySettings
ISFQuery	removeRoles(java.net.URI userUrl, java.util.ArrayList<SFSafeEnum<SFUserRole>> userRoles) Remove Roles { [ "CanManageUsers", "CanSelectFolderZone" ] } Removes the roles for user.
ISFQuery	resendWelcome(java.net.URI url) Send Welcome Email Resends the 'welcome' email to the given user
ISFQuery<SFUser>	resetPassword(java.net.URI url, SFODataObject properties) Reset Password { "NewPassword":"new password", "OldPassword":"old password" } { "NewPassword":"new password", "OldPassword":"old password" } Resets a user password.
ISFQuery<SFUser>	resetPassword(java.net.URI url, SFODataObject properties, java.lang.Boolean notify) Reset Password { "NewPassword":"new password", "OldPassword":"old password" } { "NewPassword":"new password", "OldPassword":"old password" } Resets a user password.
ISFQuery	sendConfirmationEmail(java.lang.String email) Send notification email address to this email address for verification
ISFQuery<SFODataFeed<SFShare>>	sentMessages(java.net.URI url) Get Sent Messages Returns sent messages for the given user.User identifier
ISFQuery<SFODataFeed<SFItem>>	sharepointConnectors() Get List of User Shared Folders Retrieve the connector folders that are associated with a sharepoint service
ISFQuery<SFUser>	update(java.net.URI url, SFUser user) Update User { "FirstName":"FirstName", "LastName":"LastName", "Company":"Company", "Email":"user@domain.com", "Security": { "IsDisabled":false } "DefaultZone": { "Id":"newzoneid" } } Modifies an existing user object The following parameters can be modified through this call: FirstName, LastName, Company, Email, IsDisabled, DefaultZone Id
ISFQuery<SFUser>	updateAccountUser(java.lang.String id, SFAccountUser user) Update Employee or Promote Customer { "FirstName":"FirstName", "LastName":"LastName", "Company":"Company", "Email":"user@domain.com", "StorageQuotaLimitGB":100, "Security": { "IsDisabled":false } "DefaultZone": { "Id":"newzoneid" } } Modifies an existing user object The following parameters can be modified through this call: FirstName, LastName, Company, Email, IsEmployee, IsDisabled, DefaultZone Id, StorageQuotaLimitGB.During a promotion (the user id points to Customer), the following parameters can be modified: CanCreateFolders, CanUseFileBox, CanManageUsers.
ISFQuery<SFUserPreferences>	updatePreferences(java.net.URI parentUrl, SFUserPreferences preferences) Update User Preferences { "EnableFlashUpload":"true", "EnableJavaUpload":"true" .
ISFQuery<SFUser>	updateRoles(java.net.URI parentUrl, SFUser user) Add Roles { "Roles" : [ "CanManageUsers", "CanSelectFolderZone" ] } Modifies an existing user object to ADD a new role The following roles can be added to the user through this call (depending on User type): CanCreateFolders, CanSelectFolderZone, CanUseFileBox, CanManageUsers, AdminSharedAddressBook, CanChangePassword, CanManageMySettings
ISFQuery<SFRedirection>	webAppAddEmployee() Create a one-time use login Uri for the Web App.
ISFQuery<SFRedirection>	webAppLink() Create a one-time use login Uri for the Web App.
ISFQuery<SFRedirection>	webAppManageUser(java.net.URI url) Create a one-time use login Uri for the Web App.
ISFQuery<SFRedirection>	webAppManageUsers() Create a one-time use login Uri for the Web App.

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

SFUsersEntity

public SFUsersEntity(ISFApiClient client)

Method Detail

get

public ISFQuery<SFUser> get(java.lang.String id,
                   java.lang.String emailAddress)
                     throws InvalidOrMissingParameterException

Get User Retrieve a single user, by ID or email, or the currently authenticated user.

Parameters:

id - (default: null)

emailAddress - (default: null)

Returns:

the requested User object

Throws:

InvalidOrMissingParameterException

get

public ISFQuery<SFUser> get(java.lang.String id)
                     throws InvalidOrMissingParameterException

Get User Retrieve a single user, by ID or email, or the currently authenticated user.

Parameters:

id - (default: null)

Returns:

the requested User object

Throws:

InvalidOrMissingParameterException

get

public ISFQuery<SFUser> get()

Get User Retrieve a single user, by ID or email, or the currently authenticated user.

Returns:

the requested User object

create

public ISFQuery<SFUser> create(SFUser user,
                      java.lang.Boolean pushCreatorDefaultSettings,
                      java.lang.Boolean addshared,
                      java.lang.Boolean notify,
                      java.lang.Boolean ifNecessary,
                      java.lang.Boolean addPersonal)
                        throws InvalidOrMissingParameterException

Create Client User { "Email":"user.one@domain.com", "FirstName":"Name", "LastName":"Last Name", "Company":"Company", "Password":"password", "Preferences": { "CanResetPassword":true, "CanViewMySettings":true }, "DefaultZone": { "Id":"zoneid" } } Creates a new Client User and associates it to an Account The following parameters from the input object are used: Email, FirstName, LastName, Company, DefaultZone, Password, Preferences.CanResetPassword and Preferences.CanViewMySettingsOther parameters are ignored

Parameters:

user -

pushCreatorDefaultSettings - (default: false)

addshared - (default: false)

notify - (default: false)

ifNecessary - (default: false)

addPersonal - (default: false)

Returns:

The new user

Throws:

InvalidOrMissingParameterException

create

public ISFQuery<SFUser> create(SFUser user,
                      java.lang.Boolean pushCreatorDefaultSettings,
                      java.lang.Boolean addshared,
                      java.lang.Boolean notify,
                      java.lang.Boolean ifNecessary)
                        throws InvalidOrMissingParameterException

Create Client User { "Email":"user.one@domain.com", "FirstName":"Name", "LastName":"Last Name", "Company":"Company", "Password":"password", "Preferences": { "CanResetPassword":true, "CanViewMySettings":true }, "DefaultZone": { "Id":"zoneid" } } Creates a new Client User and associates it to an Account The following parameters from the input object are used: Email, FirstName, LastName, Company, DefaultZone, Password, Preferences.CanResetPassword and Preferences.CanViewMySettingsOther parameters are ignored

Parameters:

user -

pushCreatorDefaultSettings - (default: false)

addshared - (default: false)

notify - (default: false)

ifNecessary - (default: false)

Returns:

The new user

Throws:

InvalidOrMissingParameterException

create

public ISFQuery<SFUser> create(SFUser user,
                      java.lang.Boolean pushCreatorDefaultSettings,
                      java.lang.Boolean addshared,
                      java.lang.Boolean notify)
                        throws InvalidOrMissingParameterException

Create Client User { "Email":"user.one@domain.com", "FirstName":"Name", "LastName":"Last Name", "Company":"Company", "Password":"password", "Preferences": { "CanResetPassword":true, "CanViewMySettings":true }, "DefaultZone": { "Id":"zoneid" } } Creates a new Client User and associates it to an Account The following parameters from the input object are used: Email, FirstName, LastName, Company, DefaultZone, Password, Preferences.CanResetPassword and Preferences.CanViewMySettingsOther parameters are ignored

Parameters:

user -

pushCreatorDefaultSettings - (default: false)

addshared - (default: false)

notify - (default: false)

Returns:

The new user

Throws:

InvalidOrMissingParameterException

create

public ISFQuery<SFUser> create(SFUser user,
                      java.lang.Boolean pushCreatorDefaultSettings,
                      java.lang.Boolean addshared)
                        throws InvalidOrMissingParameterException

Create Client User { "Email":"user.one@domain.com", "FirstName":"Name", "LastName":"Last Name", "Company":"Company", "Password":"password", "Preferences": { "CanResetPassword":true, "CanViewMySettings":true }, "DefaultZone": { "Id":"zoneid" } } Creates a new Client User and associates it to an Account The following parameters from the input object are used: Email, FirstName, LastName, Company, DefaultZone, Password, Preferences.CanResetPassword and Preferences.CanViewMySettingsOther parameters are ignored

Parameters:

user -

pushCreatorDefaultSettings - (default: false)

addshared - (default: false)

Returns:

The new user

Throws:

InvalidOrMissingParameterException

create

public ISFQuery<SFUser> create(SFUser user,
                      java.lang.Boolean pushCreatorDefaultSettings)
                        throws InvalidOrMissingParameterException

Create Client User { "Email":"user.one@domain.com", "FirstName":"Name", "LastName":"Last Name", "Company":"Company", "Password":"password", "Preferences": { "CanResetPassword":true, "CanViewMySettings":true }, "DefaultZone": { "Id":"zoneid" } } Creates a new Client User and associates it to an Account The following parameters from the input object are used: Email, FirstName, LastName, Company, DefaultZone, Password, Preferences.CanResetPassword and Preferences.CanViewMySettingsOther parameters are ignored

Parameters:

user -

pushCreatorDefaultSettings - (default: false)

Returns:

The new user

Throws:

InvalidOrMissingParameterException

create

public ISFQuery<SFUser> create(SFUser user)
                        throws InvalidOrMissingParameterException

Create Client User { "Email":"user.one@domain.com", "FirstName":"Name", "LastName":"Last Name", "Company":"Company", "Password":"password", "Preferences": { "CanResetPassword":true, "CanViewMySettings":true }, "DefaultZone": { "Id":"zoneid" } } Creates a new Client User and associates it to an Account The following parameters from the input object are used: Email, FirstName, LastName, Company, DefaultZone, Password, Preferences.CanResetPassword and Preferences.CanViewMySettingsOther parameters are ignored

Parameters:

user -

Returns:

The new user

Throws:

InvalidOrMissingParameterException

createAccountUser

public ISFQuery<SFUser> createAccountUser(SFAccountUser user,
                                 java.lang.Boolean pushCreatorDefaultSettings,
                                 java.lang.Boolean addshared,
                                 java.lang.Boolean notify,
                                 java.lang.Boolean ifNecessary,
                                 java.lang.Boolean addPersonal)
                                   throws InvalidOrMissingParameterException

Create Employee { "Email":"user.one@domain.com", "FirstName":"Name", "LastName":"Last Name", "Company":"Company", "Password":"password", "StorageQuotaLimitGB":50, "Preferences": { "CanResetPassword":true, "CanViewMySettings":true }, "DefaultZone": { "Id":"zoneid" }, "IsAdministrator": false, "CanCreateFolders": false, "CanUseFileBox": true, "CanManageUsers": false, "Roles": [ "CanChangePassword", "CanManageMySettings", "CanUseFileBox, "CanManageUsers, "CanCreateFolders, "CanUseDropBox, "CanSelectFolderZone, "AdminAccountPolicies", "AdminBilling", "AdminBranding", "AdminChangePlan", "AdminFileBoxAccess", "AdminManageEmployees", "AdminRemoteUploadForms", "AdminReporting", "AdminSharedDistGroups", "AdminSharedAddressBook", "AdminViewReceipts", "AdminDelegate", "AdminManageFolderTemplates", "AdminEmailMessages", "AdminSSO", "AdminSuperGroup", "AdminZones", "AdminCreateSharedGroups", "AdminConnectors" ] } Creates a new Employee User (AccountUser) and associates it to an Account The following parameters from the input object are used: Email, FirstName, LastName, Company, DefaultZone, Password, IsEmployee, IsAdministrator, CanCreateFolders, CanUseFileBox, CanManageUsers, Preferences.CanResetPassword and Preferences.CanViewMySettings. Other parameters are ignoredStorageQuotaLimitGB parameter is optional. If not specified or equal to -1 the account default storage quota value will be set for the User.

Parameters:

user -

pushCreatorDefaultSettings - (default: false)

addshared - (default: false)

notify - (default: false)

ifNecessary - (default: false)

addPersonal - (default: false)

Returns:

The new employee user

Throws:

InvalidOrMissingParameterException

createAccountUser

public ISFQuery<SFUser> createAccountUser(SFAccountUser user,
                                 java.lang.Boolean pushCreatorDefaultSettings,
                                 java.lang.Boolean addshared,
                                 java.lang.Boolean notify,
                                 java.lang.Boolean ifNecessary)
                                   throws InvalidOrMissingParameterException

Create Employee { "Email":"user.one@domain.com", "FirstName":"Name", "LastName":"Last Name", "Company":"Company", "Password":"password", "StorageQuotaLimitGB":50, "Preferences": { "CanResetPassword":true, "CanViewMySettings":true }, "DefaultZone": { "Id":"zoneid" }, "IsAdministrator": false, "CanCreateFolders": false, "CanUseFileBox": true, "CanManageUsers": false, "Roles": [ "CanChangePassword", "CanManageMySettings", "CanUseFileBox, "CanManageUsers, "CanCreateFolders, "CanUseDropBox, "CanSelectFolderZone, "AdminAccountPolicies", "AdminBilling", "AdminBranding", "AdminChangePlan", "AdminFileBoxAccess", "AdminManageEmployees", "AdminRemoteUploadForms", "AdminReporting", "AdminSharedDistGroups", "AdminSharedAddressBook", "AdminViewReceipts", "AdminDelegate", "AdminManageFolderTemplates", "AdminEmailMessages", "AdminSSO", "AdminSuperGroup", "AdminZones", "AdminCreateSharedGroups", "AdminConnectors" ] } Creates a new Employee User (AccountUser) and associates it to an Account The following parameters from the input object are used: Email, FirstName, LastName, Company, DefaultZone, Password, IsEmployee, IsAdministrator, CanCreateFolders, CanUseFileBox, CanManageUsers, Preferences.CanResetPassword and Preferences.CanViewMySettings. Other parameters are ignoredStorageQuotaLimitGB parameter is optional. If not specified or equal to -1 the account default storage quota value will be set for the User.

Parameters:

user -

pushCreatorDefaultSettings - (default: false)

addshared - (default: false)

notify - (default: false)

ifNecessary - (default: false)

Returns:

The new employee user

Throws:

InvalidOrMissingParameterException

createAccountUser

public ISFQuery<SFUser> createAccountUser(SFAccountUser user,
                                 java.lang.Boolean pushCreatorDefaultSettings,
                                 java.lang.Boolean addshared,
                                 java.lang.Boolean notify)
                                   throws InvalidOrMissingParameterException

Create Employee { "Email":"user.one@domain.com", "FirstName":"Name", "LastName":"Last Name", "Company":"Company", "Password":"password", "StorageQuotaLimitGB":50, "Preferences": { "CanResetPassword":true, "CanViewMySettings":true }, "DefaultZone": { "Id":"zoneid" }, "IsAdministrator": false, "CanCreateFolders": false, "CanUseFileBox": true, "CanManageUsers": false, "Roles": [ "CanChangePassword", "CanManageMySettings", "CanUseFileBox, "CanManageUsers, "CanCreateFolders, "CanUseDropBox, "CanSelectFolderZone, "AdminAccountPolicies", "AdminBilling", "AdminBranding", "AdminChangePlan", "AdminFileBoxAccess", "AdminManageEmployees", "AdminRemoteUploadForms", "AdminReporting", "AdminSharedDistGroups", "AdminSharedAddressBook", "AdminViewReceipts", "AdminDelegate", "AdminManageFolderTemplates", "AdminEmailMessages", "AdminSSO", "AdminSuperGroup", "AdminZones", "AdminCreateSharedGroups", "AdminConnectors" ] } Creates a new Employee User (AccountUser) and associates it to an Account The following parameters from the input object are used: Email, FirstName, LastName, Company, DefaultZone, Password, IsEmployee, IsAdministrator, CanCreateFolders, CanUseFileBox, CanManageUsers, Preferences.CanResetPassword and Preferences.CanViewMySettings. Other parameters are ignoredStorageQuotaLimitGB parameter is optional. If not specified or equal to -1 the account default storage quota value will be set for the User.

Parameters:

user -

pushCreatorDefaultSettings - (default: false)

addshared - (default: false)

notify - (default: false)

Returns:

The new employee user

Throws:

InvalidOrMissingParameterException

createAccountUser

public ISFQuery<SFUser> createAccountUser(SFAccountUser user,
                                 java.lang.Boolean pushCreatorDefaultSettings,
                                 java.lang.Boolean addshared)
                                   throws InvalidOrMissingParameterException

Create Employee { "Email":"user.one@domain.com", "FirstName":"Name", "LastName":"Last Name", "Company":"Company", "Password":"password", "StorageQuotaLimitGB":50, "Preferences": { "CanResetPassword":true, "CanViewMySettings":true }, "DefaultZone": { "Id":"zoneid" }, "IsAdministrator": false, "CanCreateFolders": false, "CanUseFileBox": true, "CanManageUsers": false, "Roles": [ "CanChangePassword", "CanManageMySettings", "CanUseFileBox, "CanManageUsers, "CanCreateFolders, "CanUseDropBox, "CanSelectFolderZone, "AdminAccountPolicies", "AdminBilling", "AdminBranding", "AdminChangePlan", "AdminFileBoxAccess", "AdminManageEmployees", "AdminRemoteUploadForms", "AdminReporting", "AdminSharedDistGroups", "AdminSharedAddressBook", "AdminViewReceipts", "AdminDelegate", "AdminManageFolderTemplates", "AdminEmailMessages", "AdminSSO", "AdminSuperGroup", "AdminZones", "AdminCreateSharedGroups", "AdminConnectors" ] } Creates a new Employee User (AccountUser) and associates it to an Account The following parameters from the input object are used: Email, FirstName, LastName, Company, DefaultZone, Password, IsEmployee, IsAdministrator, CanCreateFolders, CanUseFileBox, CanManageUsers, Preferences.CanResetPassword and Preferences.CanViewMySettings. Other parameters are ignoredStorageQuotaLimitGB parameter is optional. If not specified or equal to -1 the account default storage quota value will be set for the User.

Parameters:

user -

pushCreatorDefaultSettings - (default: false)

addshared - (default: false)

Returns:

The new employee user

Throws:

InvalidOrMissingParameterException

createAccountUser

public ISFQuery<SFUser> createAccountUser(SFAccountUser user,
                                 java.lang.Boolean pushCreatorDefaultSettings)
                                   throws InvalidOrMissingParameterException

Create Employee { "Email":"user.one@domain.com", "FirstName":"Name", "LastName":"Last Name", "Company":"Company", "Password":"password", "StorageQuotaLimitGB":50, "Preferences": { "CanResetPassword":true, "CanViewMySettings":true }, "DefaultZone": { "Id":"zoneid" }, "IsAdministrator": false, "CanCreateFolders": false, "CanUseFileBox": true, "CanManageUsers": false, "Roles": [ "CanChangePassword", "CanManageMySettings", "CanUseFileBox, "CanManageUsers, "CanCreateFolders, "CanUseDropBox, "CanSelectFolderZone, "AdminAccountPolicies", "AdminBilling", "AdminBranding", "AdminChangePlan", "AdminFileBoxAccess", "AdminManageEmployees", "AdminRemoteUploadForms", "AdminReporting", "AdminSharedDistGroups", "AdminSharedAddressBook", "AdminViewReceipts", "AdminDelegate", "AdminManageFolderTemplates", "AdminEmailMessages", "AdminSSO", "AdminSuperGroup", "AdminZones", "AdminCreateSharedGroups", "AdminConnectors" ] } Creates a new Employee User (AccountUser) and associates it to an Account The following parameters from the input object are used: Email, FirstName, LastName, Company, DefaultZone, Password, IsEmployee, IsAdministrator, CanCreateFolders, CanUseFileBox, CanManageUsers, Preferences.CanResetPassword and Preferences.CanViewMySettings. Other parameters are ignoredStorageQuotaLimitGB parameter is optional. If not specified or equal to -1 the account default storage quota value will be set for the User.

Parameters:

user -

pushCreatorDefaultSettings - (default: false)

Returns:

The new employee user

Throws:

InvalidOrMissingParameterException

createAccountUser

public ISFQuery<SFUser> createAccountUser(SFAccountUser user)
                                   throws InvalidOrMissingParameterException

Create Employee { "Email":"user.one@domain.com", "FirstName":"Name", "LastName":"Last Name", "Company":"Company", "Password":"password", "StorageQuotaLimitGB":50, "Preferences": { "CanResetPassword":true, "CanViewMySettings":true }, "DefaultZone": { "Id":"zoneid" }, "IsAdministrator": false, "CanCreateFolders": false, "CanUseFileBox": true, "CanManageUsers": false, "Roles": [ "CanChangePassword", "CanManageMySettings", "CanUseFileBox, "CanManageUsers, "CanCreateFolders, "CanUseDropBox, "CanSelectFolderZone, "AdminAccountPolicies", "AdminBilling", "AdminBranding", "AdminChangePlan", "AdminFileBoxAccess", "AdminManageEmployees", "AdminRemoteUploadForms", "AdminReporting", "AdminSharedDistGroups", "AdminSharedAddressBook", "AdminViewReceipts", "AdminDelegate", "AdminManageFolderTemplates", "AdminEmailMessages", "AdminSSO", "AdminSuperGroup", "AdminZones", "AdminCreateSharedGroups", "AdminConnectors" ] } Creates a new Employee User (AccountUser) and associates it to an Account The following parameters from the input object are used: Email, FirstName, LastName, Company, DefaultZone, Password, IsEmployee, IsAdministrator, CanCreateFolders, CanUseFileBox, CanManageUsers, Preferences.CanResetPassword and Preferences.CanViewMySettings. Other parameters are ignoredStorageQuotaLimitGB parameter is optional. If not specified or equal to -1 the account default storage quota value will be set for the User.

Parameters:

user -

Returns:

The new employee user

Throws:

InvalidOrMissingParameterException

update

public ISFQuery<SFUser> update(java.net.URI url,
                      SFUser user)
                        throws InvalidOrMissingParameterException

Update User { "FirstName":"FirstName", "LastName":"LastName", "Company":"Company", "Email":"user@domain.com", "Security": { "IsDisabled":false } "DefaultZone": { "Id":"newzoneid" } } Modifies an existing user object The following parameters can be modified through this call: FirstName, LastName, Company, Email, IsDisabled, DefaultZone Id

Parameters:

url -

user -

Returns:

a modified user record

Throws:

InvalidOrMissingParameterException

updateRoles

public ISFQuery<SFUser> updateRoles(java.net.URI parentUrl,
                           SFUser user)
                             throws InvalidOrMissingParameterException

Add Roles { "Roles" : [ "CanManageUsers", "CanSelectFolderZone" ] } Modifies an existing user object to ADD a new role The following roles can be added to the user through this call (depending on User type): CanCreateFolders, CanSelectFolderZone, CanUseFileBox, CanManageUsers, AdminSharedAddressBook, CanChangePassword, CanManageMySettings

Parameters:

parentUrl -

user -

Returns:

a modified user record

Throws:

InvalidOrMissingParameterException

patchRoles

public ISFQuery<SFUser> patchRoles(java.net.URI parentUrl,
                          SFUser user)
                            throws InvalidOrMissingParameterException

Set Roles { "Roles" : [ "CanManageUsers", "CanSelectFolderZone" ] } Sets the roles for a user (roles not provided will be disabled.) The following roles can be set to the user through this call (depending on User type): CanCreateFolders, CanSelectFolderZone, CanUseFileBox, CanManageUsers, AdminSharedAddressBook, CanChangePassword, CanManageMySettings

Parameters:

parentUrl -

user -

Returns:

a modified user record

Throws:

InvalidOrMissingParameterException

removeRoles

public ISFQuery removeRoles(java.net.URI userUrl,
                   java.util.ArrayList<SFSafeEnum<SFUserRole>> userRoles)
                     throws InvalidOrMissingParameterException

Remove Roles { [ "CanManageUsers", "CanSelectFolderZone" ] } Removes the roles for user. The following roles can be removed from user through this call (depending on User type): CanCreateFolders, CanSelectFolderZone, CanUseFileBox, CanManageUsers, AdminSharedAddressBook, CanChangePassword, CanManageMySettings

Parameters:

userUrl -

userRoles -

Throws:

InvalidOrMissingParameterException

updateAccountUser

public ISFQuery<SFUser> updateAccountUser(java.lang.String id,
                                 SFAccountUser user)
                                   throws InvalidOrMissingParameterException

Update Employee or Promote Customer { "FirstName":"FirstName", "LastName":"LastName", "Company":"Company", "Email":"user@domain.com", "StorageQuotaLimitGB":100, "Security": { "IsDisabled":false } "DefaultZone": { "Id":"newzoneid" } } Modifies an existing user object The following parameters can be modified through this call: FirstName, LastName, Company, Email, IsEmployee, IsDisabled, DefaultZone Id, StorageQuotaLimitGB.During a promotion (the user id points to Customer), the following parameters can be modified: CanCreateFolders, CanUseFileBox, CanManageUsers. StorageQuotaLimitGB equal to -1 sets the user quota to the account default storage quota value.

Parameters:

id -

user -

Returns:

a modified user record

Throws:

InvalidOrMissingParameterException

getHomeFolder

public ISFQuery<SFItem> getHomeFolder(java.net.URI url)
                               throws InvalidOrMissingParameterException

Get HomeFolder Returns a user's home folder

Parameters:

url -

Returns:

A folder record representing the requesting user home folder

Throws:

InvalidOrMissingParameterException

getTopFolders

public ISFQuery<SFODataFeed<SFItem>> getTopFolders(java.net.URI url)
                                            throws InvalidOrMissingParameterException

Get User's top Folder

Parameters:

url -

Returns:

User's Top Folders

Throws:

InvalidOrMissingParameterException

box

public ISFQuery<SFODataFeed<SFItem>> box(java.net.URI url)
                                  throws InvalidOrMissingParameterException

Get User's FileBox children

Parameters:

url -

Returns:

User's FileBox children

Throws:

InvalidOrMissingParameterException

fileBox

public ISFQuery<SFItem> fileBox(java.net.URI url)
                         throws InvalidOrMissingParameterException

Get User's FileBox folder

Parameters:

url -

Returns:

User's FileBox

Throws:

InvalidOrMissingParameterException

getPreferences

public ISFQuery<SFUserPreferences> getPreferences(java.net.URI url)
                                           throws InvalidOrMissingParameterException

Get User Preferences Retrieves the User preferences record - all user-selected prefernces, such as timezone, time format, sort preferences, etc.

Parameters:

url -

Returns:

the user selected preferences

Throws:

InvalidOrMissingParameterException

updatePreferences

public ISFQuery<SFUserPreferences> updatePreferences(java.net.URI parentUrl,
                                            SFUserPreferences preferences)
                                              throws InvalidOrMissingParameterException

Update User Preferences { "EnableFlashUpload":"true", "EnableJavaUpload":"true" . . . }

Parameters:

parentUrl -

preferences -

Throws:

InvalidOrMissingParameterException

getSecurity

public ISFQuery<SFUserSecurity> getSecurity(java.net.URI url)
                                     throws InvalidOrMissingParameterException

Get User Security Retrieve the user security record - current state of the user regarding security and password settings.

Parameters:

url -

Returns:

the user security status

Throws:

InvalidOrMissingParameterException

resetPassword

public ISFQuery<SFUser> resetPassword(java.net.URI url,
                             SFODataObject properties,
                             java.lang.Boolean notify)
                               throws InvalidOrMissingParameterException

Reset Password { "NewPassword":"new password", "OldPassword":"old password" } { "NewPassword":"new password", "OldPassword":"old password" } Resets a user password. A user can reset his own password providing the old and new passwords. Administrators can issue this call without providing the old password.

Parameters:

url -

properties -

notify - (default: false)

Returns:

The modified user record

Throws:

InvalidOrMissingParameterException

resetPassword

public ISFQuery<SFUser> resetPassword(java.net.URI url,
                             SFODataObject properties)
                               throws InvalidOrMissingParameterException

Reset Password { "NewPassword":"new password", "OldPassword":"old password" } { "NewPassword":"new password", "OldPassword":"old password" } Resets a user password. A user can reset his own password providing the old and new passwords. Administrators can issue this call without providing the old password.

Parameters:

url -

properties -

Returns:

The modified user record

Throws:

InvalidOrMissingParameterException

forgotPassword

public ISFQuery forgotPassword(java.lang.String email,
                      java.lang.Boolean resetOnMobile)
                        throws InvalidOrMissingParameterException

Forgot Password Triggers a reset password email

Parameters:

email -

resetOnMobile - (default: false)

Throws:

InvalidOrMissingParameterException

forgotPassword

public ISFQuery forgotPassword(java.lang.String email)
                        throws InvalidOrMissingParameterException

Forgot Password Triggers a reset password email

Parameters:

email -

Throws:

InvalidOrMissingParameterException

resendWelcome

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

Send Welcome Email Resends the 'welcome' email to the given user

Parameters:

url -

Throws:

InvalidOrMissingParameterException

delete

public ISFQuery delete(java.net.URI url,
              java.lang.Boolean completely)
                throws InvalidOrMissingParameterException

Delete User Removes an user

Parameters:

url -

completely - (default: false)

Throws:

InvalidOrMissingParameterException

delete

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

Delete User Removes an user

Parameters:

url -

Throws:

InvalidOrMissingParameterException

getAllSharedFolders

public ISFQuery<SFODataFeed<SFItem>> getAllSharedFolders()

Get List of User Shared Folders Retrieve the list of shared folders the authenticated user has access to

Returns:

A list of Folder objects, representing shared folders of an user

getTopFolders

public ISFQuery<SFODataFeed<SFItem>> getTopFolders()

Get List of User Shared Folders Retrieve the top-level folders for this user. This method requires the account to be in the new UI model of "My Files", "Shared", "Connectors", "Favorites" tab - otherwise it will return an empty list (new UX model is the default since May 2013).

Returns:

A list of Folder objects, representing shared folders of an user

networkShareConnectors

public ISFQuery<SFODataFeed<SFItem>> networkShareConnectors()

Get List of User Shared Folders Retrieve the connector folders that are associated with a network share service

Returns:

A list of Folder objects, representing network shared connector folders of an user

sharepointConnectors

public ISFQuery<SFODataFeed<SFItem>> sharepointConnectors()

Get List of User Shared Folders Retrieve the connector folders that are associated with a sharepoint service

Returns:

A list of Folder objects, representing sharepoint folders of an user

confirm

public ISFQuery confirm(SFUserConfirmationSettings settings)
                 throws InvalidOrMissingParameterException

Confirm the current user logging in for the first time { "FirstName":"", "LastName":"", "Company":"", "Password":"", "SecurityQuestion":"", "SecurityQuestionAnswer":"", "DayLightName":"", "UTCOffset":"", "DateFormat":"", "TimeFormat":"", "EmailInterval":0 }

Parameters:

settings -

Returns:

no data on success

Throws:

InvalidOrMissingParameterException

getInfo

public ISFQuery<SFUserInfo> getInfo()

Get Current User Info

Returns:

UserInfo

deleteEmailAddress

public ISFQuery<SFUser> deleteEmailAddress(java.lang.String email)
                                    throws InvalidOrMissingParameterException

Delete the email address from user

Parameters:

email -

Returns:

User

Throws:

InvalidOrMissingParameterException

makePrimary

public ISFQuery<SFUser> makePrimary(java.lang.String email)
                             throws InvalidOrMissingParameterException

Set email address as the primary email address for CURRENT user

Parameters:

email -

Returns:

User

Throws:

InvalidOrMissingParameterException

sendConfirmationEmail

public ISFQuery sendConfirmationEmail(java.lang.String email)
                               throws InvalidOrMissingParameterException

Send notification email address to this email address for verification

Parameters:

email -

Returns:

User

Throws:

InvalidOrMissingParameterException

webAppLink

public ISFQuery<SFRedirection> webAppLink()

Create a one-time use login Uri for the Web App.

Returns:

Redirection populated with link in Uri field

inboxMetadata

public ISFQuery<SFInboxMetadata> inboxMetadata(java.net.URI url)
                                        throws InvalidOrMissingParameterException

Get Inbox Metadata Returns metadata of the inbox.User identifier

Returns:

Inbox metadata

Throws:

InvalidOrMissingParameterException

getInbox

public ISFQuery<SFODataFeed<SFShare>> getInbox(java.net.URI url,
                                      SFSafeEnum<SFShareType> type,
                                      java.lang.Boolean archived)
                                        throws InvalidOrMissingParameterException

Get Inbox for Recipient Retrieve all outstanding Shares in the inbox.User identifier

Returns:

List of Shares created by the authenticated user

Throws:

InvalidOrMissingParameterException

getInbox

public ISFQuery<SFODataFeed<SFShare>> getInbox(java.net.URI url,
                                      SFSafeEnum<SFShareType> type)
                                        throws InvalidOrMissingParameterException

Get Inbox for Recipient Retrieve all outstanding Shares in the inbox.User identifier

Returns:

List of Shares created by the authenticated user

Throws:

InvalidOrMissingParameterException

getInbox

public ISFQuery<SFODataFeed<SFShare>> getInbox(java.net.URI url)
                                        throws InvalidOrMissingParameterException

Get Inbox for Recipient Retrieve all outstanding Shares in the inbox.User identifier

Returns:

List of Shares created by the authenticated user

Throws:

InvalidOrMissingParameterException

sentMessages

public ISFQuery<SFODataFeed<SFShare>> sentMessages(java.net.URI url)
                                            throws InvalidOrMissingParameterException

Get Sent Messages Returns sent messages for the given user.User identifier

Returns:

Feed of Shares

Throws:

InvalidOrMissingParameterException

webAppManageUser

public ISFQuery<SFRedirection> webAppManageUser(java.net.URI url)
                                         throws InvalidOrMissingParameterException

Create a one-time use login Uri for the Web App.

Parameters:

url -

Returns:

Redirection populated with link in Uri field

Throws:

InvalidOrMissingParameterException

webAppManageUsers

public ISFQuery<SFRedirection> webAppManageUsers()

Create a one-time use login Uri for the Web App.

Returns:

Redirection populated with link in Uri field

webAppAddEmployee

public ISFQuery<SFRedirection> webAppAddEmployee()

Create a one-time use login Uri for the Web App.

Returns:

Redirection populated with link in Uri field