Options

You have several options and variables to pass through to load the edtior according to your choice and your project needs. The options are passed as additional query string parameters to the authorization request (Step 1 request).

For example - If you want to pass user name and user color, your request would be Request:

http://www.breadsoftware.com/getSession?api=xxxxxxx&document=http://www.yourserver.com/doc/abc.docx&userName=John&userColor=00ffff&height=100%&width=100%

The response is a JSON string with sessionid
{"code":0,"message":"ok","data":{"sessionID":"xxxxxx"}}

Optional Parameters

Parameter Description Value Type Example
height Height of editor
Example: 100% or 800px
Can be in % or px Required height=100%
width Width of editor
Example: 100% or 600px
Can be in % or px Required width=100%
userName Name of user within your application
If userName is not passed, Bread assumes the name as Anonymous
Alphanumeric String Optional userName=John Doe
userColor Color for user for syntax highlighting, comments & review.
If userColor is not passed, Bread assigns the color on it's own.
Color Hex Code without # character Optional userName=00ffxx
showPrint Disable printing on document. No Optional showPrint=No
readOnly Load editor in read only mode.
User cannot make changes to document.
Yes Optional readOnly=Yes
showDownload Disable document download buttons No Optional showDownload=No
showChat Disable chat on editor No Optional showChat=No
showShareDocument Disable share document button on collaborate tab No Optional showShareDocument=No
showEmailDocument Disable Email Invite button on collaborate tab No Optional showEmailDocument=No
forceLoad This options forces the document to be reloaded from the url
A fresh copy of document from url is loaded.
Yes Optional forceLoad=Yes
forceUpdate This options forces the document to be updated in Bread cache
A fresh copy of document from url is loaded and updated in cache.
Yes Optional forceUpdate=Yes