SimpleAttachment

Данный серверный класс содержит методы, позволяющие пользователям взаимодействовать с вложениями.

SimpleAttachment()

---

Используйте этот конструктор класса для создания пустого объекта SimpleAttachment.

SimpleAttachment()

const attach = new SimpleAttachment();

base64Decode(data)

---

Используйте этот метод, чтобы вернуть строку ASCII, декодированную из указанной строки base64.

Параметры:

Наименование	Тип	Обязательно	Значение по умолчанию
data	String	Да	Нет
strict	Boolean	Нет	true

Если входные данные содержат символы, не входящие в алфавит base64, а параметр strict задан как true, то метод base64_decode() вернет false. Если параметр strict задан как false, символы, не входящие в алфавит base64, будут пропущены.

Возвращаемое значение:

Тип	Описание
String	Метод возвращает декодированную строку.

Пример:

base64Decode()

const attach = new SimpleAttachment();
const result = attach.base64Decode('TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQ=');
ss.info(result);
// Информация: Lorem ipsum dolor sit amet

base64Encode(data)

---

Используйте метод, чтобы преобразовать указанную строку в base64.

Параметры:

Наименование	Тип	Обязательно	Значение по умолчанию
data	String	Да	Нет

Возвращаемое значение:

Тип	Описание
String	Метод возвращает закодированную строку base64.

Пример:

base64Encode()

const attach = new SimpleAttachment();
const result = attach.base64Encode('Lorem ipsum dolor sit amet');
ss.info(result);
// Информация: TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQ=

copy(sourceTableName, sourceID, targetTableName, targetID)

---

Используйте этот метод, чтобы скопировать вложения из исходной записи в целевую.

Параметры:

Наименование	Тип	Обязательно	Значение по умолчанию
sourceTableName	String	Да	Нет
sourceID	String	Да	Нет
targetTableName	String	Да	Нет
targetID	String	Да	Нет

Возвращаемое значение:

Тип	Описание
Boolean	Метод возвращает true, если вложения были успешно скопированы. В случае ошибки метод возвращает false.

Пример:

copy()

const attach = new SimpleAttachment();
attach.copy('sys_email', '155964310500000059', 'task', current.sys_id);

deleteAttachment(attachmentId)

---

Используйте этот метод, чтобы удалить указанное вложение. Параметры:

Наименование	Тип	Обязательно	Значение по умолчанию
attachmentID	String	Да	Нет

Возвращаемое значение:

Тип	Описание
Void	Метод не возвращает значение.

Пример:

deleteAttachment()

const attach = new SimpleAttachment();
attach.deleteAttachment('157052637119478714');

getAttachmentUrlById(attachmentId)

---

Используйте этот метод, чтобы получить URL указанного вложения в облачном хранилище.

Параметры:

Наименование	Тип	Обязательно	Значение по умолчанию
attachmentId	string	Да	Нет

Возвращаемое значение:

Тип	Описание
String	Метод возвращает URL-адрес вложения в облачном хранилище.

Пример:

getAttachmentUrlById()

const ATTACH_ID = '163553718313772587';
const simpleAttach = new SimpleAttachment();
const attachUrl = simpleAttach.getAttachmentUrlById(ATTACH_ID);
ss.info(attachUrl);
// Информация: https://s3-{your-instance-url}/public-attachment/5/32/9bnc2pcb3axyfatgtc6lsi7...

getContent(attachmentId)

---

Используйте данный метод, чтобы получить содержимое в поле вложения Контент. Поле Контент автоматически заполняется текстовым содержимым прикрепленного файла .txt.

Параметры:

Наименование	Тип	Обязательно	Значение по умолчанию
attachmentId	SimpleRecord	Да	Нет

Возвращаемое значение:

Тип	Описание
String/Object	Метод возвращает значение в поле вложения Контент. Если поле пустое или прикрепленный файл имеет другой формат, метод возвращает null.

Пример:

getContent()

const attach = new SimpleAttachment();
ss.info(attach.getContent('168109939701169218'));
// Информация: task active  additional_comments  approval_state ...

readBase64(attachmentId)

---

Используйте этот метод, чтобы получить закодированную строку из указанного вложения. Вместе с методом writeBase64() может использоваться для копирования вложений.

внимание

Размер вложения не должен превышать 10 Мб. В случае превышения метод возвращает пустую строку, а в Журнале исключений (sys_log_exception) появляется запись: File size exceeded allowed limit.

Параметры:

Наименование	Тип	Обязательно	Значение по умолчанию
attachmentId	String	Да	Нет

Возвращаемое значение:

Тип	Описание
String	Метод возвращает закодированную строку base64. В случае, если файл слишком большой, возвращаемая строка может быть пустой.

Пример:

readBase64()

const read = new SimpleAttachment();
ss.info(read.readBase64('168025458107121347'));
// Информация: 0YLQtdGB0YLQvtCy0YvQuSDQtNC+0LrRg9C80LXQvdGC

rename(attachmentId, fileName)

---

Используйте данный метод, чтобы изменить название файла и его расширение.

Параметры:

Наименование	Тип	Обязательно	Значение по умолчанию
attachmentId	String	Да	Нет
fileName	String	Да	Нет

Возвращаемое значение:

Тип	Описание
Void	Метод не возвращает значение.

Пример:

rename()

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, mimeContentType)

---

Используйте данный метод, чтобы создать и добавить вложение в указанную запись.

Параметры:

Наименование	Тип	Обязательно	Значение по умолчанию
documentId	String	Да	Нет
filename	String	Да	Нет
content	String	Да	Нет
mimeContentType	String	Да	Нет

Возвращаемое значение:

Тип	Описание
String	Метод возвращает ID вложения; в случае ошибки возвращает null.

Пример:

write()

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, mimeContentType)

---

Используйте данный метод для создания и добавления вложения к указанной записи, закодированного при помощи base64. Вы можете использовать этот метод вместе с readBase64() для копирования вложений.

Параметры:

Наименование	Тип	Обязательно	Значение по умолчанию
documentID	String	Да	Нет
fileName	String	Да	Нет
base64	String	Да	Нет
mimeContentType	String	Да	Нет

Возвращаемое значение:

Тип	Описание
String	Метода возвращает ID вложения; в случае ошибки возвращает null.

Пример:

writeBase64()

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);
//Информация: 162245472311776172