Предоставляет инструменты для работы с папками. Например, для создания новой папки, для поиска требуемой папки по ее ИД.
Свойства:
Имя
|
Тип
|
Описание
|
contentType
|
OBJECT_TYPE
|
Тип содержимого фабрики
|
Функции
createFolder – создать новую папку
Синтаксис:
createFolder(contentType, opt_name, opt_modelType)
Параметры:
Имя
|
Тип
|
Обязательность
|
Описание
|
contentType
|
FOLDER_CONTENT_TYPE
|
Да
|
Тип содержимого папки
|
opt_name
|
String
|
Нет
|
Наименование папки
|
opt_modelType
|
MODEL
|
Да
|
Тип возвращаемой модели данных
|
Исключения:
• | ERR_NOT_ALL_REQUIRED_ARGUMENTS_HAVE_BEEN_SUPLIED – заданы не все обязательные параметры. |
Возвращаемое значение:
Специальный deferred-объект.
Пример 1:
// Создать папку и открыть ее карточку.
WA.FC.folders.сreateFolder(FOLDER_CONTENT_TYPE.ANY, 'FolderName').done(function(folder) {
folder.open();
});
Пример 2:
// Создать, настроить и сохранить папку. Сохраненная папка откроется в проводнике веб-доступа.
WA.FC.folders.сreateFolder({
contentType: FOLDER_CONTENT_TYPE.ANY,
name: 'Новая папка',
autoSave: true
}).done(function(folder) {
folder.open();
});
|
getFolderByID – получить папку по ее ИД
Синтаксис:
getFolderByID(id, opt_modelType)
Параметры:
Имя
|
Тип
|
Описание
|
id
|
Integer
|
ИД папки
|
opt_modelType
|
MODEL
|
Тип возвращаемой модели данных
|
Возвращаемое значение:
Искомая папка.
Пример:
// Проверить, что папка существует.
WebAccess.factories.folders.getFolderByID().done(function(folder) {
console.log('Папка существует')
}).fail(function(error) {
console.log('Не удалось найти папку с указанным id');
console.log(error);
});
|
getRootFolderID – получить ИД предопределенной папки
Синтаксис:
getRootFolderID(folderType)
Параметры:
Возвращаемое значение:
ИД папки.
Пример:
// Получить ИД предопределенной папки «Избранное» текущего пользователя.
var favoritesId = WebAccess.factories.folders.getRootFolderID(FOLDER_TYPE.FAVORITES);
|
isRootFolder – проверить, является ли указанная папка корневой
Синтаксис:
isRootFolder(folderID)
Параметры:
Имя
|
Тип
|
Описание
|
folderID
|
Integer
|
ИД папки
|
Возвращаемое значение:
True – папка является корневой, иначе False.
|
|
См. также