Данный серверный класс включает в себя методы, позволяющие пользователям настраивать взаимодействие с вложениями.
SimpleAttachment()
Используйте этот метод для создания пустого объекта SimpleAttachment.
Code Block |
---|
language | js |
---|
theme | Eclipse |
---|
title | SimpleAttachment |
---|
linenumbers | true |
---|
|
const attach = new SimpleAttachment(); |
base64Decode(data)
Этот метод возвращает строку ASCII, декодированную из указанной строки base64.
Параметры:
Название | Тип | Обязательный | Значение по умолчанию |
---|
data | String | Да | Нет |
Возвращаемое значение:
Тип | Описание |
---|
String | Декодированная строка |
Пример:
Code Block |
---|
language | js |
---|
theme | Eclipse |
---|
title | base64Decode |
---|
linenumbers | true |
---|
|
const attach = new SimpleAttachment();
const result =
attach.base64Decode('TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQ=');
ss.info(result); |
base64Encode(data)
Этот метод возвращает строку Base64 из указанной строки.
Параметры:
Название | Тип | Обязательный | Значение по умолчанию |
---|
data | String | Да | Нет |
Возвращаемое значение:
Тип | Описание |
---|
String | Закодированная строка Base64 |
Пример:
Code Block |
---|
language | js |
---|
theme | Eclipse |
---|
title | base64Encode |
---|
linenumbers | true |
---|
|
const attach = new SimpleAttachment();
const result =
attach.base64Encode('Lorem ipsum dolor sit amet');
ss.info(result); |
copy(sourceTableName, sourceID, targetTableName, targetID)
Используйте этот метод, чтобы скопировать вложения из исходной записи в целевую.
Параметры:
Название | Тип | Обязательный | Значение по умолчанию |
---|
sourceTableName | String | Да | Нет |
sourceID | String | Да | Нет |
targetTableName | String | Да | Нет |
targetID | String | Да | Нет |
Возвращаемое значение:
Тип | Описание |
---|
Boolean | Метод возвращает true,если вложения были успешно скопированы. В случае ошибки метод возвращает false. |
Пример:
Code Block |
---|
language | js |
---|
theme | Eclipse |
---|
title | copy |
---|
linenumbers | true |
---|
|
const attach = new SimpleAttachment();
attach.copy('sys_email', '155964310500000059', 'task', current.sys_id); |
deleteAttachment(attachmentID)
Используйте этот метод, чтобы удалить указанное вложение.
Параметры:
Название | Тип | Обязательный | Значение по умолчанию |
---|
attachmentID | String | Да | Нет |
Возвращаемое значение:
Тип | Описание |
---|
Void | Метод не возвращает значение. |
Пример:
Code Block |
---|
language | js |
---|
theme | Eclipse |
---|
title | deleteAttachment |
---|
|
const attach = new SimpleAttachment();
attach.deleteAttachment('157052637119478714'); |
getAttachmentUrlById(attachmentId)
Используйте этот метод, чтобы получить URL указанного вложения в облачном хранилище.
Параметры:
Название | Тип | Обязательный | Значение по умолчанию |
---|
attachmentId | string | Да | Нет |
Возвращаемое значение:
Тип | Описание |
---|
String | Этот метод возвращает URL-адрес вложения в облачном хранилище. |
Пример:
Code Block |
---|
language | js |
---|
theme | Eclipse |
---|
title | getAttachmentUrlById |
---|
linenumbers | true |
---|
|
const current = new SimpleRecord('sys_attachment');
current.get('163553718313772587');
const ATTACH_ID = current.sys_id;
const simpleAttach = new SimpleAttachment();
const attachUrl = simpleAttach.getAttachmentUrlById(ATTACH_ID);
ss.info(attachUrl);
//Info: https://s3-{your-instance-url}/public-attachment/5/32/9bnc2pcb3axyfatgtc6lsi7... |
getContent(sysAttachment)
Используйте данный метод, чтобы получить содержимое вложения в виде строки.
Параметры:
Название | Тип | Обязательный | Значение по умолчанию |
---|
sysAttachment | SimpleRecord | Да | Нет |
Возвращаемое значение:
Тип | Описание |
---|
String | Содержание вложения в виде строки |
Пример:
Code Block |
---|
language | js |
---|
theme | Eclipse |
---|
title | getContent |
---|
linenumbers | true |
---|
|
const attach = new SimpleAttachment();
const content = attach.getContent('157052637119478714'); |
readBase64(attachmentId)
Этот метод позволяет получить закодированную строку из указанного вложения.
Note |
---|
Размер вложения не должен превышать 10 Mb. В случае превышения метод возвращает исключение: Размер файла превышает допустимый лимитдопустимое значение . |
Параметры:
Название | Тип | Обязательный | Значение по умолчанию |
---|
attachmentId | String | Да | Нет |
Возвращаемое значение:
Тип | Описание |
---|
String | Закодированная строка Base64 |
Пример:
Code Block |
---|
language | js |
---|
theme | Eclipse |
---|
title | readBase64 |
---|
linenumbers | true |
---|
|
const read = new SimpleAttachment();
ss.info(read.readBase64('159050716911764097')); |
rename(attachmentId, fileName)
Используйте этот метод, чтобы изменить название указанного вложения.
Параметры:
Название | Тип | Обязательный | Значение по умолчанию |
---|
attachmentId | String | Да | Нет |
fileName | String | Да | Нет |
Возвращаемое значение:
Тип | Описание |
---|
Void | Метод не возвращает значение. |
Пример:
Code Block |
---|
language | js |
---|
theme | Eclipse |
---|
title | rename |
---|
linenumbers | true |
---|
|
const DOC_ID = ss.getDocIdByIds(current.sys_db_table_id, current.sys_id);
const simpleAttach = new SimpleAttachment();
const attachRecord = new SimpleRecord('sys_attachment');
attachRecord.addQuery('record_document_id', DOC_ID);
attachRecord.addQuery('mime_content_type', 'application/json');
attachRecord.selectAttributes('sys_id');
attachRecord.query();
attachRecord.next();
simpleAttach.rename(attachRecord.sys_id, `${current.number} - ${current.subject}.json`); |
write(documentId, fileName, content, contentType)
Используйте данный метод, чтобы добавить вложение в указанную запись.
Параметры:
Название | Тип | Обязательный | Значение по умолчанию |
---|
documentId | String | Да | Нет |
filename | String | Да | Нет |
content | String | Да | Нет |
contentType | String | Да | Нет |
Возвращаемое значение:
Тип | Описание |
---|
String | Метод возвращает sys_ID вложения; в случае ошибки возвращает null. |
Пример:
Code Block |
---|
language | js |
---|
theme | Eclipse |
---|
title | write |
---|
linenumbers | true |
---|
|
const simpleAttach = new SimpleAttachment();
const attachID =
simpleAttach.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)
Данный метод предназначен для добавления вложения к указанной записи при помощи кодирования Base64.
Параметры:
Название | Тип | Обязательный | Значение по умолчанию |
---|
documentID | String | Да | Нет |
fileName | String | Да | Нет |
base64 | String | Да | Нет |
contentType | String | Да | Нет |
Возвращаемое значение:
Тип | Описание |
---|
String или NULL | Метода возвращает sys_ID вложения;в случае ошибки возвращает null. |
Пример:
Code Block |
---|
language | js |
---|
theme | Eclipse |
---|
title | writeBase64 |
---|
linenumbers | true |
---|
|
const CURRENT_USER_DOC_ID = ss.getDocIdByIds(ss.getUser().sys_db_table_id, ss.getUserID());
const simpleAttach = new SimpleAttachment();
const base64Value = 'R0lGODlhAQABAIAAAP///wAAACwAAAAAAQABAAACAkQBADs=';
const attachId = simpleAttach.writeBase64(
CURRENT_USER_DOC_ID,
'file_example.gif',
base64Value,
'image/gif'
);
ss.info(attachId);
//Info: 162245472311776172 |