public class Sdk extends Object
| Constructor and Description |
|---|
Sdk(String orchestratorServer,
String username,
String password)
Constructor of SpreadSheetSpace Sdk.
|
| Modifier and Type | Method and Description |
|---|---|
ChangeRecipientDescriptor |
addRecipients(String id,
String view_server,
LinkedList<String> listRecipient)
Add recipient(s) to existing view.
|
ViewDescriptor |
createPrivateView(String description,
Set<String> recipients,
String[][] table,
String excelTemplate,
boolean isTable,
boolean hasHeaders,
Integer rows,
Integer cols)
Create a SpreadSheetSpace View and send it to a specific set of recipients.
|
ViewDescriptor |
createPublicView(String description,
String[][] table,
String excelTemplate,
boolean isTable,
boolean hasHeaders,
Integer rows,
Integer cols)
Create a SpreadSheetSpace View on the marketplace.
|
UserDescriptor |
createUser(String firstname,
String lastname,
String userName,
String passWord,
String email)
Create a new SpreadSheetSpace User in your Team.
|
ViewDescriptor |
deleteView(String viewId,
String viewServer)
Delete an owned view on SpreadSheetSpace.
|
ViewDescriptor |
deleteViews(List<ViewObj> listView)
Delete owned views on SpreadSheetSpace.
|
GenerateKeyDescriptor |
generateKey()
Generate your personal public and private keys.
|
AddressBookDescriptor |
getAddressBook()
Retrieve my addressbook list.
|
ListViewDescriptor |
getInboxView()
Retrieve my inbox views list.
|
ListViewDescriptor |
getOwnedView()
Retrieve my owned views list.
|
ValuesViewDescriptor |
getValuesView(String view_id,
String view_server,
String private_key,
String excelTemplate)
Retrieve values from view.
|
protected ViewServer |
getViewServer() |
ViewDescriptor |
publishPublicView(String id,
String view_server,
String comment)
Publish on SpreadSheetSpace Marketplace of an existing Public View.
|
ChangeRecipientDescriptor |
removeRecipients(String id,
String view_server,
LinkedList<String> listRecipient)
Remove recipient(s) to existing view.
|
UserDescriptor |
updateUserPassword(String Username,
String Password)
Update your password or the password of a SpreadSheetSpace User in your Team.
|
ViewDescriptor |
updateView(ViewDescriptor viewDescriptor,
String[][] table,
String excelTemplate)
Update the data and the template of an existing SpreadSheetSpace View.
|
public Sdk(String orchestratorServer, String username, String password) throws Exception
orchestratorServer - Server address of SpreadSheetSpace infrastructure (e.g. "https://www.spreadsheetspace.net")username - The username that will be used to authenticate on the SpreadSheetSpace server.password - The password that will be used to authenticate on the SpreadSheetSpace server.Exceptionprotected ViewServer getViewServer()
public ViewDescriptor publishPublicView(String id, String view_server, String comment)
id - This string represents the View identifier.view_server - This string represents the server address where the View is stored.comment - This string represents a detailed description of the View. This description is shows as a comment on SpreadSheetSpace Marketplace.public ViewDescriptor createPublicView(String description, String[][] table, String excelTemplate, boolean isTable, boolean hasHeaders, Integer rows, Integer cols) throws FileNotFoundException
description - The description of the View.table - A matrix that represents the values of the View cells.excelTemplate - The path to the Excel file that will be used as a template. Set it "null" if you want to create a View without template.isTable - Set it "true" if you want to create a View with Excel table.hasHeaders - If "isTable" is "true" set it true if the first line of your data rappresent the header of your Excel table.rows - rows represent the number of rows of your View. If rows equals "-1" and cols equals "-1" the View is full-sheet.cols - cols represent the number of columns of your View. If rows equals "-1" and cols equals "-1" the View is full-sheet.FileNotFoundExceptionpublic ViewDescriptor createPrivateView(String description, Set<String> recipients, String[][] table, String excelTemplate, boolean isTable, boolean hasHeaders, Integer rows, Integer cols) throws FileNotFoundException
description - The description of the View.recipients - A list of mail addresses that represent the recipients of the View.table - A matrix that represents the values of the View cells.excelTemplate - The path to the Excel file that will be used as a template. Set it "null" if you want to create a View without template.isTable - Set it "true" if you want to create a View with Excel table.hasHeaders - If "isTable" is "true" set it true if the first line of your data rappresent the header of your Excel table.rows - rows represent the number of rows of your View. If rows equals "-1" and cols equals "-1" the View is full-sheet.cols - cols represent the number of columns of your View. If rows equals "-1" and cols equals "-1" the View is full-sheet.FileNotFoundExceptionpublic ViewDescriptor updateView(ViewDescriptor viewDescriptor, String[][] table, String excelTemplate)
viewDescriptor - A descriptor of the View that that you want to update. See the documentation of "ViewDescriptor" for more details.table - A matrix that represents the values of the View cells.excelTemplate - The path to the Excel file that will be used as a template. Set it "null" if you don't want to update the View template.public ViewDescriptor deleteView(String viewId, String viewServer)
viewId - This string represents the View identifier.viewServer - This string represents the server address where the View is stored.public ViewDescriptor deleteViews(List<ViewObj> listView)
listView - This list represents a list of Views to delete.public AddressBookDescriptor getAddressBook()
public ListViewDescriptor getOwnedView()
public ListViewDescriptor getInboxView()
public GenerateKeyDescriptor generateKey()
public ValuesViewDescriptor getValuesView(String view_id, String view_server, String private_key, String excelTemplate)
view_id - This string represents the View identifier.view_server - This string represents the server address where the View is stored.private_key - This string represents your private key.excelTemplate - The path in where to store the View Excel template file. Set it "null" if you don't want to retrieve the View template.public ChangeRecipientDescriptor addRecipients(String id, String view_server, LinkedList<String> listRecipient)
id - This string represents the View identifier.view_server - This string represents the server address where the View is stored.listRecipient - Recipient mail list to added.public ChangeRecipientDescriptor removeRecipients(String id, String view_server, LinkedList<String> listRecipient)
id - This string represents the View identifier.view_server - This string represents the server address where the View is storedlistRecipient - Recipient mail list to remove.public UserDescriptor createUser(String firstname, String lastname, String userName, String passWord, String email)
firstname - The firstname of the new user.lastname - The lastname of the new user.userName - The username of the new user.passWord - The password of the new user.email - The email of the new user.public UserDescriptor updateUserPassword(String Username, String Password)
Username - The username of the user.Password - The new password of the user.Copyright © 2018. All rights reserved.