Sdk

This library allows a developer to integrate his code with the SpreadSheetSpace functionalities. It allows you to create and update SpreadSheetSpace Views. See the documentation of "SpreadSheetSpace" for more details on site "https://www.spreadsheetspace.net/".

Constructor

Constructor of SpreadSheetSpace Sdk. Call it for initialize the sdk. You can verify the result in the State of Sdk. See the documentation of "State" for more details.

Params
  • 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.

Sdk.createPrivateView

Create a SpreadSheetSpace View and send it to a specific set of recipients.

Params
  • 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. Default is -1.
  • cols: cols represent the number of columns of your View. If rows equals "-1" and cols equals "-1" the View is full-sheet. Default is -1.
Returns

Return a descriptor of the created View. See the documentation of "ViewDescriptor" for more details.

Sdk.createPublicView

Create a SpreadSheetSpace View on the marketplace. This View is hidden, you have to "Publish" it to make it visible. See the documentation of "publishPublicView" for more details.

Params
  • 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. Default is -1.
  • cols: cols represent the number of columns of your View. If rows equals "-1" and cols equals "-1" the View is full-sheet. Default is -1.
Returns

Return a descriptor of the created View. See the documentation of "ViewDescriptor" for more details.

Sdk.publishPublicView

Publish on SpreadSheetSpace Marketplace of an existing Public View. See the documentation of "createPublicView" to know how to create a public View.

Params
  • 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.
Returns

Return a descriptor of the created View. See the documentation of "ViewDescriptor" for more details.

Sdk.updateView

Update the data and the template of an existing SpreadSheetSpace View. See the documentation of "createPrivateView" or "createPublicView" to know how to create a View.

Params
  • 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.
Returns

Return a descriptor of the updated View. See the documentation of "ViewDescriptor" for more details.

Sdk.deleteView

Delete an owned view on SpreadSheetSpace.

Params
  • id: This string represents the View identifier.
  • view_server: This string represents the server address where the View is stored.
Returns

Return a descriptor of the deleted View. See the documentation of "DeleteViewDescriptor" for more details.

Sdk.deleteViews

Delete owned views on SpreadSheetSpace.

Params
  • listView: This list represents a list of Views to delete.
Returns

Return a descriptor of the deleted View. See the documentation of "DeleteViewDescriptor" for more details.

Sdk.getAddressBook

Retrieve my addressbook list.

Returns

Return a descriptor of Addressbook list. See the documentation of "AddressbookDescriptor" for more details.

Sdk.getOwnedView

Retrieve my owned views list.

Returns

Return a descriptor of UserView list. See the documentation of "ListViewDescriptor" for more details.

Sdk.getInboxView

Retrieve my inbox views list.

Returns

Return a descriptor of UserView list. See the documentation of "ListViewDescriptor" for more details.

Sdk.addRecipients

Add recipient(s) to existing view.

Params
  • 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.
Returns

Return a descriptor of addRecipients. See the documentation of "ChangeRecipientDescriptor" for more details.

Sdk.removeRecipients

Remove recipient(s) to existing view.

Params
  • 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 remove.
Returns

Return a descriptor of removeRecipients. See the documentation of "ChangeRecipientDescriptor" for more details.

Sdk.createUser

Create a new SpreadSheetSpace User in your Team. ONLY an admin of your Team can performe this operation.

Params
  • 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.
Returns

Return a descriptor of createUser. See the documentation of "UserDescriptor" for more details.

Sdk.updateUserPassword

Update your password or the password of a SpreadSheetSpace User in your Team. ONLY an admin of your Team can performe this operation on another user.

Params
  • username: The username of the user.
  • password: The new password of the user.
Returns

Return a descriptor of updatePassword. See the documentation of "UserDescriptor" for more details.

Sdk.GenerateKey

Generate your personal public and private keys.

Returns

Return a descriptor of your keys. See the documentation of "GenerateKeyDescriptor" for more details.

Sdk.getValuesView

Retrieve values from view.

Params
  • 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.
Returns

Return a descriptor of view's values. See the documentation of "ValuesViewDescriptor" for more details.

Sdk.State

Getter of State of SpreadSheetSpace Sdk. See the documentation of "SdkStatus" for more details.

UserDescriptor

Response object for create/update user request

UserDescriptor.Username

This string represents the username of the request user.

UserDescriptor.StatusCode

This integer represents the response code for the action.

UserDescriptor.Message

This string represents a message associated to the StatusCode.

ViewDescriptor

Response object for create/update/publish View

Constructor

Constructor of SpreadSheetSpace ViewDescriptor to use for updating of a view.

Params
  • viewId: The identifier of the View that you want to update.
  • viewServer: The server address where is stored the view you want to update.
  • nextAvailableSequenceNumber: The sequence number of the view update.

ViewDescriptor.ViewId

This string represents the identifier of the View.

ViewDescriptor.ViewServer

This string represents the server address where the View is stored.

ViewDescriptor.StatusCode

This integer represents the response code for the action that was performed on the current View.

ViewDescriptor.Message

This string represents a message associated to the StatusCode.

ViewDescriptor.NextAvailableSequenceNumber

This long represents a sequence number that must be send to the next update of the current View.

GenerateKeyDescriptor

Response object for GenerateKey

Constructor

Constructor of SpreadSheetSpace GenerateKey.

Params
  • publicKey: Generated public key.
  • privateKey: Generated private key.
  • statusCode: Status of operation.
  • message: Details message of operations.

GenerateKeyDescriptor.PublicKey

This string represents the public key.

GenerateKeyDescriptor.PrivateKey

This string represents the private key.

GenerateKeyDescriptor.StatusCode

This integer represents the response code for the GenerateKey action.

GenerateKeyDescriptor.Message

This string represents a message associated to the StatusCode.

ValuesViewDescriptor

Response object for getValuesView

Constructor

Constructor of SpreadSheetSpace getValuesView.

Params
  • values: View's values.
  • statusCode: Status of operation.
  • message: Details message of operations.

ValuesViewDescriptor.Values

This matrix represents view's values.

ValuesViewDescriptor.StatusCode

This integer represents the response code for the getValuesView action.

ValuesViewDescriptor.Message

This string represents a message associated to the StatusCode.

ChangeRecipientDescriptor

Response object for Add/Remove recipient request

Constructor

Constructor of SpreadSheetSpace ChangeRecipientDescriptor.

Params
  • viewId: The identifier of the View that you want to update.
  • viewServer: The server address where is stored the view you want to update.
  • statusCode: Status of operation.
  • message: Details message of operations.

ChangeRecipientDescriptor.ViewId

This string represents the identifier of the View.

ChangeRecipientDescriptor.ViewServer

This string represents the server address where the View is stored.

ChangeRecipientDescriptor.StatusCode

This integer represents the response code for the action.

ChangeRecipientDescriptor.Message

This list represents a message associated to the StatusCode.

DeleteViewDescriptor

Response object for delete view request

Constructor

Constructor of SpreadSheetSpace DeleteViewtDescriptor.

Params
  • statusCode: Status of operation.
  • message: Details message of operations.

DeleteViewDescriptor.StatusCode

This integer represents the response code for the action.

DeleteViewDescriptor.Message

This list represents a message associated to the StatusCode.

ListViewDescriptor

Response object for getOwnedView and getInboxView

Constructor

Constructor of SpreadSheetSpace ListViewDescriptor.

Params
  • listView: Owned views list.
  • statusCode: Status of operation.
  • message: Details message of operations.

ListViewDescriptor.ListView

This list represents the owned views.

ListViewDescriptor.StatusCode

This integer represents the response code for the action that was performed on the current View.

ListViewDescriptor.Message

This string represents a message associated to the StatusCode.

AddressbookDescriptor

Response object for Addressbook request

Constructor

Constructor of SpreadSheetSpace AddressbookDescriptor.

Params
  • listContact: The addresbook list of specified user.
  • statusCode: Status of operation.
  • message: Details message of operations.

AddressbookDescriptor.ListContact

This list represents the addresbook.

AddressbookDescriptor.StatusCode

This integer represents the response code for the action.

AddressbookDescriptor.Message

This string represents a message associated to the StatusCode.

SdkStatus

This object rappresent the current state of SpreadSheetSpace Sdk. You can know the state of the SpreadSheetSpace Sdk at any time by reading this object.

SdkStatus.StatusCode

Get the code of the SpreadSheetSpace Sdk state.

SdkStatus.Message

Get a description of the SpreadSheetSpace Sdk state.

Contact

Standard information for SpreadSheetSpace contact.

Constructor

Constructor of Contact.

Params
  • firstName: Firstanme of contact.
  • lastName: Lastname of contact.
  • emailAddress: Mail of contact.

Contact.firstName

Firstname of contact.

Contact.lastName

Lastname of contact.

Contact.emailAddress

Mail of contact.

UserView

Standard information for SpreadSheetSpace UserView.

Constructor

Constructor of SpreadSheetSpace UserView.

Params
  • view_id: The identifier of the View.
  • view_server: The server address where is stored the view.
  • owner: This string represents the owner's mail of the View.
  • description: The description of the view.
  • listRecipients: Recipients list of view.

UserView.view_id

This string represents the identifier of the View.

UserView.view_server

This string represents the server address of the View.

UserView.owner

This string represents the owner's mail of the View.

UserView.description

This string represents the description of the View.

UserView.listRecipients

This list represents the recipients of view.