You are viewing an old version of this page. View the current version.
Compare with Current View Page History
« Previous Version 43 Next »
This server class provides methods that allow operating with attachments.
SimpleAttachment()
Instantiates a new empty SimpleAttachment object.
const attach = new SimpleAttachment();
base64Decode(data)
This method returns an ASCII string decoded from the base64 string specified.
Name | Type | Mandatory | Default Value |
---|---|---|---|
data | String | Y | N |
Return:
Type | Description |
---|---|
String | The decoded string. |
Example:
const attach = new SimpleAttachment(); attach.base64Decode('TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQsIGNvbnNlY3RldHVyIGFkaXBpc2NpbmcgZWxpdCwgc2VkIGRvIGVpdXNtb2QgdGVtcG9yIGluY2lkaWR1bnQgdXQgbGFib3JlIGV0IGRvbG9yZSBtYWduYSBhbGlxdWEuIA=='); let result = attach.base64Decode;
base64Encode(data)
This method returns a Base64 string from the string specified.
Name | Type | Mandatory | Default Value |
---|---|---|---|
data | String | Y | N |
Return:
Type | Description |
---|---|
String | The encoded Base64 string. |
Example:
const attach = new SimpleAttachment(); attach.base64Encode('Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.'); let result = attach.base64Encode;
copy(sourceTable, sourceID, targetTable, targetID)
This method copies attachments from the source record to the target record.
Parameter(s):
Name | Type | Mandatory | Default Value |
---|---|---|---|
sourceTable | String | Y | N |
sourceID | String | Y | N |
targetTable | String | Y | N |
targetID | String | Y | N |
Return:
Type | Description |
---|---|
Void | This method does not return a value. |
Example:
const attach = new SimpleAttachment(); attach.copy('sys_email', '155964310500000059', 'task', '155964310500000051');
deleteAttachment(attachmentID)
This method deletes the specified attachment.
Parameter(s):
Name | Type | Mandatory | Default Value |
---|---|---|---|
attachmentID | String | Y | N |
Return:
Type | Description |
---|---|
Void | This method does not return a value. |
Example:
const attach = new SimpleAttachment(); attach.deleteAttachment('157052637119478714');
getAttachmentUrlById(attachmentId)
This method allows to get the URL of the specified attachment at the cloud storage.
Name | Type | Mandatory | Default Value |
---|---|---|---|
attachmentId | string | Y | N |
Return:
Type | Description |
---|---|
String | This method returns the attachment URL in the cloud storage. |
Example:
const attach = new SimpleAttachment(); const publicUrl = attach.getAttachmentUrlById('157052637119478714'); ss.info(publicUrl);
getContent(sysAttachment)
This method gets attachment content as a string.
Name | Type | Mandatory | Default Value |
---|---|---|---|
sysAttachment | SimpleRecord | Y | N |
Return:
Type | Description |
---|---|
String | The attachment content as a string. |
Example)
const attach = new SimpleAttachment(); const content = attach.getContent('157052637119478714');
readBase64(attachmentId)
This method allows to get a encoded string from the specified attachment.
The attachment size is limited up to 10 Mb; otherwise, the method throws an exception.
Parameter(s):
Name | Type | Mandatory | Default value |
---|---|---|---|
attachmentId | String | Y | N |
Return:
Type | Description |
---|---|
String | The base64-encoded string. |
const read = new SimpleAttachment(); ss.info(read.readBase64('159050716911764097'));
rename(attachmentId, fileName)
This method renames the specified attachment.
Parameter(s):
Name | Type | Mandatory | Default Value |
---|---|---|---|
attachmentId | String | Y | N |
fileName | String | Y | N |
Return:
Type | Description |
---|---|
Void | This method does not return a value. |
Example:
const attach = new SimpleAttachment(); attach.rename('157052637119478714', 'new_name_1.png');
write(documentId, fileName, content, contentType)
This method inserts the attachment to the record specified.
Name | Type | Mandatory | Default Value |
---|---|---|---|
documentId | String | Y | N |
filename | String | Y | N |
content | String | Y | N |
contentType | String | Y | N |
Return
Type | Description |
---|---|
String | The attachment's sys ID; in case of error; returns NULL. |
Example:
const attach = new SimpleAttachment(); const attachID = attach.write( ss.getDocIdByIds(current.sys_db_table_id, current.sys_id), 'readme.json', JSON.stringify(current.getAttributes(), null, "\t"), 'application/json' );
writeBase64(documentId, fileName, base64, contentType)
This method inserts the attachment to the record specified using Base64 encoding.
Name | Type | Mandatory | Default Value |
---|---|---|---|
documentID | String | Y | N |
fileName | String | Y | N |
base64 | String | Y | N |
contentType | String | Y | N |
Return
Type | Description |
---|---|
String or NULL | The attachment's sys ID; in case of error; returns NULL. |
Example:
const write = new SimpleAttachment(); const base64 = request.execute().getBody(); // base64 string const attachId = attach.writeBase64( ss.getDocIdByIds('157045360815629732', '155964310500006867'), 'watch.xlsx', base64, 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet' ); ss.info(attachId);
- No labels