 |
Вспомогательные методы (сервис Utils.asmx)
|
|
|
|
Сервис Utils.asmx содержит методы, которые не предоставляют законченной бизнес-функциональности, но могут быть полезны для приложений. Список методов, приведенный ниже, не является законченным: новые методы могут добавляться в сервис по мере необходимости.
Для вызова методов сервера пользователи должны выполнить вход в систему через BMService.asmx и передать возвращенные cookies в запросы к Utils.asmx.
| Имя метода | Назначение |
| DateTime GetServerTime(out double utcOffset) | Возвращает локальное время сервера приложений и смещение времени сервера относительно UTC. |
| string StartUpload(byte[] firstChunk); | Регистрирует новую загрузку на web-сервере |
| void Upload(string uploadID, byte[] content, long offset) | Загружает очередную порцию данных на web-сервер |
| long CompleteNewFile(string uploadID, long documentID, long fileTypeID, string fileName, long length, HashAlgorithm hashAlgorithm, byte[] hash) | Завершает загрузку и добавляет новый файл к документу. Назначение аналогично методу AddFileToDocument сервиса BMService.asmx |
| long CompleteNewVersion(string uploadID, long fileID, long length, HashAlgorithm hashAlgorithm, byte[] hash) | Завершает загрузку и добавляет новую версию к файлу |
Подробное описание методов см. пп. 9.1 - 9.5
Метод GetServerTime(out double utcOffset)
Метод возвращает локальное время сервера приложений и смещение времени сервера относительно UTC.
DateTime GetServerTime(out double utcOffset)
Необходимо иметь в виду, что в кластерных конфигурациях последовательные запросы могут быть направлены на разные компьютеры, и возвращаемые времена могут несколько различаться
Метод StartUpload
Метод регистрирует новую загрузку на web-сервере
string StartUpload(byte[] firstChunk);
Загрузка должна завершиться одним из CompleteXXX методов. Если по загрузке не будет активности в течение определенного интервала – то все загруженные куски будут удалены.
Метод возвращает строку длиной не более 128 символов.
|
|
|
Пример использования см. в разделе 12..
| Имя аргумента | Назначение |
| byte[] firstChunk | Необязательный параметр, первый кусок данных файла. |
Метод Upload
Метод загружает очередную порцию данных на web-сервер
void Upload(string uploadID, byte[] content, long offset)
Все аргументы обязательные. Метод может быть безопасно вызван несколько раз с одними и теме же аргументами.
Пример использования см. в разделе 12..
| Имя аргумента | Назначение |
| string uploadID | Идентификатор загрузки, полученный при вызове метода Upload |
| byte[] content | Содержимое очередного куска файла |
| long offset | Смещение от начала файла. |
Метод CompleteNewFile
Метод завершает загрузку и добавляет новый файл к документу. Назначение аналогично методу AddFileToDocument сервиса BMService.asmx.
long CompleteNewFile(string uploadID, long documentID, long fileTypeID, string fileName,
long length, HashAlgorithm hashAlgorithm, byte[] hash)
Длина файла и хеш не являются обязательными параметрами, но если они указаны, то будут использованы при проверке целостности файла перед отправкой на сервер контента.
В аргументах и возвращаемом значении используется тип long для совместимости с будущими версиями. Но на данный момент, декабрь 2012 года, фактически значения являются 32-битным int.
Пример использования см. в разделе 12.
| Имя аргумента | Назначение |
| string uploadID | Идентификатор загрузки полученный при вызове метода Upload. Обязательный аргумент. |
| long documentID | Идентификатор документа. Обязательный аргумент. |
| long fileTypeID | Идентификатор типа файла зарегистрированного в LanDocs. Обязательный аргумент. |
| string fileName | Имя файла. Обязательный аргумент. |
| long length | Длина файла. Если указано значение больше 0, то перед проверкой длина загруженного файла будет выставлена в данное значение. Для игнорирования параметра передавайте -1. |
| HashAlgorithm hashAlgorithm | Алгоритм хеширования. Допустимые значения None, SHA1 и MD5 |
| byte[] hash | Значение хеша. Обязательно указывать, если в тип алгоритма передано значение отличное от None. |
|
|
|
Метод CompleteNewVersion
Метод завершает загрузку и добавляет новую версию к файлу.
long CompleteNewVersion(string uploadID, long fileID,
long length, HashAlgorithm hashAlgorithm, byte[] hash)
Длина файла и хеш не являются обязательными параметрами, но если они указаны, то будут использованы при проверке целостности файла перед отправкой на сервер контента.
В аргументах и возвращаемом значении используется тип long для совместимости с будущими версиями. Но на данный момент, декабрь 2012 года, фактически значения являются 32-битным int.
Пример использования см. в разделе 12..
| Имя аргумента | Назначение |
| string uploadID | Идентификатор загрузки полученный при вызове метода Upload. Обязательный аргумент. |
| long fileID | Идентификатор файл, к которому будет добавлена версия. Обязательный аргумент. |
| long length | Длина файла. Если указано значение больше 0, то перед проверкой длина загруженного файла будет выставлена в данное значение. Для игнорирования параметра передавайте -1. |
| HashAlgorithm hashAlgorithm | Алгоритм хеширования. Допустимые значения None, SHA1 и MD5 |
| byte[] hash | Значение хеша. Обязательно указывать, если в тип алгоритма передано значение отличное от None. |
|
|
|
