Login

Share functions

Functions used to write data to Docly, such as data sbumitted from web apps or imported from XLSX, JSON, CSV etc.

down­loa­d(file, template, preview)

Producses a file using the specified template (HTML, PDF etc) and initiates the file download in the browser.

get­FileS­h­are­s(path)

Returns the active shares for a specific file.

add­FileS­h­are(file, user, access, message)

Creates a new share / overwrites existing for a specific file and user, and sends an invitation email to the specified user.

re­move­Fil­eS­hare(file, user)

Removes / terminates a users access to a specific file.

sen­dEmai­l(file, template, receiver, subject, message)

Producses a file using the specified template (HTML, PDF etc) and sendes the output by email.

down­loa­dE­mbed­ded(file, embeddedId, filename)

Downloads an embedded file from a document.

ge­nera­teD­ocu­men­t(file, template)

Produces a file using the specified template (HTML, PDF etc) and returns it as a byte array.

send­For­m(form, subject, sendTo, smtp, subjectPrefix, addSenderInfo)

Use this function to send a submitted form by email from an API function.

add­Fol­der­Sha­re(path, user, access, message)

Creates a new share / overwrites existing for a specific folder and user, and sends an invitation email to the specified user.

get­Fol­der­Sha­res(path)

Returns the active shares for a specific folder.

re­move­Fol­d­erS­hare(path, user)

Removes / terminates a users access to a specific file.

down­load­B­yte­s(data, filename, preview)

A method to trigger a file download from byte data or a base64 encoded string.