Please check the API for explicit specifications of paramaters and return types! The document is available here.

Uploding/Opening a document to the server:

documentHash is the reference to the now open document on the server.

If the document or a similar document has already been loaded, the documentHash returned will be null. In this case, call getDocument(String document) to retrieve the documentHash for the original document on the server.

Closing a document on the server:

Downloading/Saving a document from the server:

You receive the title of the document, the latest sequence number, and the document itself.

Browse open documents:

FILE DOCUMENT OPERATIONS:

All methods EXCEPT for locking and unlocking lines return either a error response code or a transaction/sequence number. The operation is performed, a sequence number is allocated to it. It is the client code's responsibility to make a request for any changes to the document at some interval. You can call updates() with your sequence number to get a list of all the changes to the document that have occured since the time represented by your sequence number. When you perform an operation and receive a sequence number representing the operation, the client should fetch the changes that have occured since the sequence number before the performed operation and the sequence number given for the current operation. If a change submitted conflicts with a previous change (i.e. you attempt to lock a line that someone just deleted), the system realizes that your unaware of the transaction that just occured (because your sequence number is < that transaction's sequence number) and the operation returns with an error indicating the appropriate error).

Lock/Unlock a line:

Why lock lines?

Prevents other from accessing the line and conflicting with your modifications to the line. It is recommended that you lock lines before editing them, but the methods that modify line contents will automatically lock lines for the user. If the operation spans over multiple lines and a lock cannot be obtained for any single line, the operation fails and the integrity of the document is maintained.

Do I have to lock lines?

No. If you don't manage locks, the system will do it for you - free of charge.

How do I know if a line is locked?

You can attempt to lock it OR you can call getLocks() or getLocksAndUIDs() to get a list of lines that are locked and their respective lock owners.

Could operations collide?

All operations are atomic and either complete or are aborted. The integrity of the document is maintained between transactions and while transactions occur concurrently.

To lock a line for exclusive editing for a period of time defined by <= LOCK_TIMEOUT,

long response = lockLine(String documentHash, long line, long uid, long sequenceNo)

To unlock a line for before the LOCK_TIMEOUT,

long response = unlockLine(String documentHash, long line, long uid, long sequenceNo)

Adding, Modifying and Deleting Lines:

Adding one or more consecutive lines

long response = addLine(String documentHash, long line, long userID, String toAdd, long sequenceNo)

Lines are terminated by a \n in toAdd. Threfore, toAdd = "line1\nline2\n" adds two consecutives lines starting at "line".

Modifying one line

long response = updateLine(String documentHash, long line, long userID, String toModify, long sequenceNo)

Deleting one line

long response = deleteLine(String documentHash, long line, long userID, long sequenceNo)

Insert (copy and paste) and Delete (cut):

Insert text into a text region

long response = insert(String documentHash, long line, long userID, int startPosition, int endPosition, String toInsert, long sequenceNo)

Replace the text between startPosition and endPosition with the text noted in toInsert on the line.

Delete text from a region

long response = delete(String documentHash, long line, long userID, int startPosition, int endPosition, long sequenceNo)

Remove the text between startPosition and endPosition on the line.

Sample Application: