Symphony Add-on API Overview

Abstract

ShowTable of Contents

HideTable of Contents

1 Available functionality
2 Access the API
3 Articles using the API

The Symphony Add-on API of XPages2Eclipse builds a bridge between XPages applications and the embedded Symphony application of the Lotus Notes Client.

Available functionality

The API contains almost the whole set of classes and methods from the Symphony SDK

that is available for Symphony version 3.

In short, it covers reading and writing data from/to Symphony Documents, Spreadsheets and Presentations. The full Javadoc for the supported classes is available here in this product wiki.

Please note that for Lotus Notes 8.5.2, the embedded Symphony has to be updated to version 3 first (using the add-on installer available from IBM) to be able to use the XPages2Eclipse Symphony Add-on API.
However, this is not required for Lotus Notes 8.5.3, which will already contain the newest Symphony release.

Access the API

You get access to the embedded Symphony application instance by calling the method com.x2e.SymphonyAPI.getApplication(conn) with a valid XPages2Eclipse connection object.
Afterwards you can use the available methods to work with the currently open content:

var conn=X2E.createConnection();
var app=com.x2e.SymphonyAPI.getApplication(conn);

//get a handle on the active Document, Spreadsheet or Presentation:
var activeDoc=app.getActiveDocument();
var activeSpreadsheet=app.getActiveSpreadsheet();
var activePresentation=app.getActivePresentation();

//access collections of all open Documents, Spreadsheets and Presentations
var documents=app.getDocuments();
var spreadsheets=app.getSpreadsheets();
var presentations=app.getPresentations();

Using the collection objects, you can also create a new element:

var template=""; //Specifies the name of the template to be used, use "" for no template;
var asTemplate=false; //When a template is used, this parameter specifies true to creates a new
//untitled element based on the template, and it specifies false to load the template
//for editing. If no template is used, both true and false create a new untitled element.
var visible=true; //Specify true to open the new element in a visible window or tab,
//or false to open the new element in invisible mode
var newDoc=documents.addDocument(template, asTemplate, visible);
var newSpreadsheet=spreadsheets.addSpreadsheet(template, asTemplate, visible);
var newPresentation=spreadsheets.addPresentation(template, asTemplate, visible);