MBroker
 Указатель Классы Пространства имен Файлы Функции Переменные Определения типов Перечисления Элементы перечислений Свойства
Открытые члены | Полный список членов класса
Интерфейс MBroker.BrokerServiceV2.IFileService

Открытые члены

string GetContextV2 (string user, string password, string clientUuid, string hostName, string clientAppName, string varParams)
 Получение контекста пользователя Подробнее...
 
string UploadFileFBM (string contextId, string date, string fileName, string className, int idRecord, string type, string fileType, string mirror)
 Метод загрузки файла на сервер Подробнее...
 
string GetFileFBM (string contextId, string fileId, string mirror)
 Метод получения файла с сервера Подробнее...
 
void DeleteFileFBM (string contextId, string fileId, string mirror)
 Удаление файла Подробнее...
 
string GetFileInfoFBM (string contextId, string fileId)
 Метод служит для получения информации о файле Подробнее...
 
string GetFileInfo (string contextId, string guid)
 Метод служит для получения информации о файле Подробнее...
 
void DeleteFile (string contextId, string guid)
 Метод служит для удаления файла из хранилища Подробнее...
 
void DeleteFileInfo (string contextId, string guid)
 Метод служит для удаления записи о файле из хранилища Подробнее...
 

Методы

void MBroker.BrokerServiceV2.IFileService.DeleteFile ( string  contextId,
string  guid 
)

Метод служит для удаления файла из хранилища

Аргументы
contextIdId контекста
guidИдентификатор файла
void MBroker.BrokerServiceV2.IFileService.DeleteFileFBM ( string  contextId,
string  fileId,
string  mirror 
)

Удаление файла

Аргументы
contextIdИдентификатор контекста
fileIdСтрока с уникальным идентификатором файла
mirrorЗеркало, на котором хранится файл
void MBroker.BrokerServiceV2.IFileService.DeleteFileInfo ( string  contextId,
string  guid 
)

Метод служит для удаления записи о файле из хранилища

Аргументы
contextIdId контекста
guidИдентификатор файла
string MBroker.BrokerServiceV2.IFileService.GetContextV2 ( string  user,
string  password,
string  clientUuid,
string  hostName,
string  clientAppName,
string  varParams 
)

Получение контекста пользователя

Аргументы
userИмя пользователя
passwordПароль
clientUuidUUID клиента
hostNameНазвание рабочей станции клиента
clientAppNameНазвание клиентского приложения
varParamsДополнительные параметры в формате JSON
Исключения
InvalidUserException
IPValidationFailedException
LoginFailedException
PasswordExpiredException
ServiceUserException
SqlOperationException
UnknownUserException
UserLockedOutException
Возвращает
Идентификатор контекста пользователя

Вызов метода сбрасывает кэш пользователя и соединения с зеркалами.

  • Формат varParams
    {
    "language" : "value" // Определяет локаль подключившегося пользователя, если параметр не не задан, то автоматически русская локаль
    }
    Локаль задается текстовой строкой:
    "ru" - русская локаль\n
    "de" - немецкая локаль\n
    "uk" - украинская локаль\n
string MBroker.BrokerServiceV2.IFileService.GetFileFBM ( string  contextId,
string  fileId,
string  mirror 
)

Метод получения файла с сервера

Аргументы
contextIdИдентификатор контекста
fileIdСтрока с уникальным идентификатором файла
mirrorЗеркало, на котором хранится файл
Возвращает
Бинарные данные
  • Пример строки с уникальным идентификатором файла "5360d23bffd0070994b03f47" Пример возвращаемого значения Аналог входного параметра "date" в методе "UploadFile"
string MBroker.BrokerServiceV2.IFileService.GetFileInfo ( string  contextId,
string  guid 
)

Метод служит для получения информации о файле

Аргументы
contextIdid контекста
guidИдентификатор файла
Возвращает
JSON-объект, поля: FileName - имя файла, FileType - MIME-тип
string MBroker.BrokerServiceV2.IFileService.GetFileInfoFBM ( string  contextId,
string  fileId 
)

Метод служит для получения информации о файле

Аргументы
contextIdИдентификатор контекста
fileIdИдентификатор файла
Возвращает
JSON-объект.
поля: FileName - имя файла,
FileType - MIME-тип,
Mirror - зеркало, на котором лежит файл
string MBroker.BrokerServiceV2.IFileService.UploadFileFBM ( string  contextId,
string  date,
string  fileName,
string  className,
int  idRecord,
string  type,
string  fileType,
string  mirror 
)

Метод загрузки файла на сервер

Аргументы
contextIdИдентификатор контекста
dateБинарные данные
fileNameОригинальное имя файла
classNameИмя класса (например: T_DRIVERS)
idRecordID записи внутри выбранного класса
typeСсылка на тип файла из T_FILE_TYPES
fileTypeMIME-тип
mirrorЗеркало для загрузки файла
Возвращает
Строка с уникальным идентификатором файла
  • Пример бинарных данных
    "YWJj" Уникальный идентификатор файла
    Используется для загрузки файла с сервера

Объявления и описания членов интерфейса находятся в файле: