Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

This server class provides methods that allow operating with attachments.

SimpleAttachment()


Instantiates a new empty SimpleAttachment object.


Code Block
languagejs
themeEclipse
titleSimpleAttachment
linenumberstrue
const attach = new SimpleAttachment();


base64Decode(data)


This method returns an ASCII string decoded from the base64 string specified.

NameTypeMandatoryDefault Value
dataStringYN


Return:

TypeDescription
StringThe decoded string.

Example:

Code Block
languagejs
themeEclipse
titlebase64Decode
linenumberstrue
const attach = new SimpleAttachment();
attach.base64Decode('157052637119478714');


base64Encode(data)


This method returns a Base64 string from the string specified.

NameTypeMandatoryDefault Value
dataStringYN


Return:

TypeDescription
StringThe encoded Base64 string.

Example:

Code Block
languagejs
themeEclipse
titlebase64Encode
linenumberstrue
const attach = new SimpleAttachment();
attach.base64Encode('157052637119478714');

copy(sourceTable, sourceID, targetTable, targetID)


This method copies attachments from the source record to the target record.

Parameter(s):

NameTypeMandatoryDefault Value
sourceTableStringYN
sourceIDStringYN
targetTableStringYN
targetIDStringYN


Return:

TypeDescription
VoidThis method does not return a value.


Example:

Code Block
languagejs
themeEclipse
titlecopy
const attach = new SimpleAttachment();
attach.copy('sys_email', '155964310500000059', 'task', '155964310500000051');


createAttachmentByUrl(url, SimpleRecordId, fileName)



Parameter(s):

NameTypeMandatoryDefault Value
urlStringYN
SimpleRecordIdStringYN
fileNameStringYN


Return:

TypeDescription
String


Example:


Code Block
languagejs
themeEclipse
titlecreateAttachmentByUrl

deleteAttachment(attachmentID)


This method deletes the specified attachment.


Parameter(s):

NameTypeMandatoryDefault Value
attachmentIDStringYN


Return:

TypeDescription
VoidThis method does not return a value.


Example:

Code Block
languagejs
themeEclipse
titledeleteAttachment
const attach = new SimpleAttachment();
attach.deleteAttachment('157052637119478714');

getAttachmentUrlById(attachmentId)


This method allows to get the URL of the specified attachment at the cloud storage.


NameTypeMandatoryDefault Value
attachmentIdstringYN


Return:

TypeDescription
StringThis method returns the attachment URL in the cloud storage.

Example:

Code Block
languagejs
themeEclipse
titlegetCloudStorageUrl
linenumberstrue
const attach = new SimpleAttachment();
const publicUrl = attach.getAttachmentUrlById('157052637119478714');
ss.info(publicUrl);

getContent(sysAttachment)


This method gets attachment content as a string.

NameTypeMandatoryDefault Value
sysAttachmentSimpleRecordYN


Return:

TypeDescription
StringThe attachment content as a string.


Example)

Code Block
languagejs
themeEclipse
titlegetContent
const attach = new SimpleAttachment();
const content = attach.getContent('157052637119478714');


readBase64(attachmentId)


This method allows to get a encoded string from the specified attachment.

Note

The attachment size is limited up to 10 Mb; otherwise, the method throws an exception.


Parameter(s):

NameTypeMandatoryDefault value
attachmentIdStringYN


Return:

TypeDescription
StringThe base64-encoded string.


Code Block
languagejs
themeEclipse
titlereadBase64
linenumberstrue
const read = new SimpleAttachment();
ss.info(read.readBase64('159050716911764097'));

rename(attachmentId, fileName)


This method renames the specified attachment.


Parameter(s):

NameTypeMandatoryDefault Value
attachmentIdStringYN
fileNameStringYN


Return:

TypeDescription
VoidThis method does not return a value.


Example:

Code Block
languagejs
themeEclipse
titlerename
const attach = new SimpleAttachment();
attach.rename('157052637119478714', 'new_name_1.png');

write(record, fileName, contentType, content)


This method inserts the attachment to the record specified.

NameTypeMandatoryDefault Value
recordSimpleRecordYN
filenameStringYN
contentTypeStringYN
contentStringYN


Return

TypeDescription
StringThe attachment's sys ID.

Example:

Code Block
languagejs
themeEclipse
titlewrite
const attach = new SimpleAttachment();
const record = attach.write('157052637119478714', 'readme.md', 'text/markdown', '# h1 title');

writeBase64(documentId, fileName, base64, contentType)


This method inserts the attachment to the record specified using Base64 encoding.

NameTypeMandatoryDefault Value
documentIDStringYN
fileNameStringYN
base64StringYN
contentTypeStringYN


Return

TypeDescription
String or NULLThe attachment's sys ID; in case of error; returns NULL.

Example:

Code Block
languagejs
themeEclipse
titlewriteBase64
linenumberstrue


Table of Contents
absoluteUrltrue
classfixedPosition