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 | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
let attach = new SimpleAttachment(); |
base64Decode(data)
This method returns an ASCII string decoded from the base64 string specified.
Return:
Example:
language | js |
---|---|
theme | Eclipse |
title | base64Decode |
linenumbers | true |
base64Encode(data)
This method returns a Base64 string from the string specified.
Return:
Example:
language | js |
---|---|
theme | Eclipse |
title | base64Decode |
linenumbers | true |
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:
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
let attach = new SimpleAttachment(); attach.copy('user', '155964310500000059', 'sys_script', '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:
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
let attach = new SimpleAttachment(); attach.deleteAttachment('157052637119478714'); |
getCloudStorageUrl(attachmentId)
This method allows to get the URL of the specified attachment at the cloud storage.
NameReturn:
Example:
language | js |
---|---|
theme | Eclipse |
title | getCloudStorageUrl |
linenumbers | true |
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)
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
let attach = new SimpleAttachment(); let content = attach.getContent('157052637119478714'); |
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:
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
let attach = new SimpleAttachment(); attach.rename('157052637119478714', 'new_name_1.png'); |
write(record, fileName, contentType, content)
This method inserts the attachment to the record specified.
Name | Type | Mandatory | Default Value |
---|---|---|---|
record | SimpleRecord | Y | N |
filename | String | Y | N |
contentType | String | Y | N |
content | String | Y | N |
Return
Type | Description |
---|---|
String | The attachment's sys ID. |
Example:
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
let attach = new SimpleAttachment(); let 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.
Return
Example:
Code Block | |
---|---|
language | js |
theme | Eclipse |
title | writeBase64 | linenumbers | true
Table of Contents | ||||
---|---|---|---|---|
|