myDSSSDK Documentation

Class DSSOperations​Manager 

public final class DSSOperationsManager

Класс для управления подписанием в DSS со стороны SDK

Methods

get​Operations​List(user:​operation​Type:​operation​Id:​callback:​) 

public static func getOperationsList(
        user: DSSUser,
        operationType: String?,
        operationId: String?,
        callback: @escaping (_ result: Result<[DSSOperation], Error>) -> Void
    )

Получение списка операций с сервера DSS

Parameters

user DSSUser

Пользователь для которого нужно вывести список операций
operation​Type String?

Тип операции (опционально)
operation​Id String?

Идентификатор операции (опционально)
callback @escaping (_ result:​ Result<[DSSOperation], Error>) -> Void

Замыкание возвращает результат
result

Возвращает список операций или ошибку

confirm​Operation(operation:​user:​sign​Mode:​skip​Snippet:​is​Selection​Enabled:​callback:​) 

public static func confirmOperation(
        operation: DSSOperation,
        user: DSSUser,
        signMode: DSSSignMode,
        skipSnippet: Bool = false,
        isSelectionEnabled: Bool = false,
        callback: @escaping (_ result: Result<DSSApproveRequest, Error>) -> Void
    )

Подтверждение операции

Запускает последовательность экранов SDK: предпросмотр операции, предпросмотр прикреплённых документов, ввод пароля при подтверждении.

Parameters

operation DSSOperation

Операция для подтверждения
user DSSUser

Пользователь, чью операцию нужно подтвердить
sign​Mode DSSSign​Mode

Тип подписания — .online или .offline
skip​Snippet Bool

Если true и операция содержит всего один документ, то сразу будет показано содержимое документа, вместо сниппета
is​Selection​Enabled Bool

Если true и количество документов больше одного, то будет доступен выбор документов для подтверждения/отклонения.
callback @escaping (_ result:​ Result<DSSApprove​Request, Error>) -> Void

Замыкание возвращает результат
result

Возвращает запрос на подтверждение или ошибку

confirm​Operation(approve​Request:​callback:​) 

public static func confirmOperation(
        approveRequest: DSSApproveRequest,
        callback: @escaping (_ result: Result<Void, Error>) -> Void
    )

Подтверждение операции путем отправки заранее подготовленного запроса на подтверждение

Parameters

approve​Request DSSApprove​Request

Запрос на подтверждение
callback @escaping (_ result:​ Result<Void, Error>) -> Void

Замыкание возвращает результат
result

Ничего не возвращает в случае успеха. Иначе — возвращает ошибку.

get​Operations​Info(user:​interval:​operation​Id:​callback:​) 

public static func getOperationsInfo(
        user: DSSUser,
        interval: TimeInterval? = nil,
        operationId: String? = nil,
        callback: @escaping (_ result: Result<[DSSOperationInfo], Error>) -> Void
    )

Получение сведений об операциях

Параметр interval определяет интервал времени (в секундах) для поиска операций. Если параметр указан, то сервис вернёт все операции созданные после (.now - interval).

Если задан параметр operationID, то будет возвращена только операция с данным идентификатором.

Метод доступен только для API v1.1.

Parameters

user DSSUser

Пользователь, для которого была создана операция
interval Time​Interval?

Интервал времени, за который нужно искать операции
operation​Id String?

Идентификатор операции
callback @escaping (_ result:​ Result<[DSSOperation​Info], Error>) -> Void

Замыкание возвращает результат
result

Результаты подписания или ошибка

get​Document​Description(document​Id:​user:​callback:​) 

public static func getDocumentDescription(
        documentId: String,
        user: DSSUser,
        callback: @escaping (_ result: Result<DSSDocument, Error>) -> Void
    )

Получение информации о документе

Parameters

document​Id String

Идентификатор документа
user DSSUser

Пользователь-владелец документа
callback @escaping (_ result:​ Result<DSSDocument, Error>) -> Void

Замыкание возвращает результат
result

Возвращает информацию о документе или ошибку

upload​Document(document​Content:​title:​snippet​Template:​preview​Template:​user:​callback:​) 

public static func uploadDocument(
        documentContent: Data,
        title: String,
        snippetTemplate: String?,
        previewTemplate: String?,
        user: DSSUser,
        callback: @escaping (_ result: Result<String, Error>) -> Void
    )

Загрузка документа на сервер

Parameters

document​Content Data

Содержимое документа
title String

Название документа с расширением. Например, "document.txt"
snippet​Template String?

HTML-шаблон snippet'а документа
preview​Template String?

HTML-шаблон preview документа
user DSSUser

Пользователь-владелец документа
callback @escaping (_ result:​ Result<String, Error>) -> Void

Замыкание возвращает результат
result

Возвращает ндентификатор документа или ошибку

sign​Documents(documents​IDs:​user:​sign​Params:​callback:​) 

public static func signDocuments(
        documentsIDs: [String],
        user: DSSUser,
        signParams: DSSSignParams,
        callback: @escaping (_ result: Result<[DSSSignResult], Error>) -> Void
    )

Подписание документов

Запускает последовательность экранов SDK: предпросмотр документов, ввод пароля для подписи.

Parameters

documents​IDs [String]

Идентификаторы документов для подписания
user DSSUser

Пользователь, подписывающий документы
sign​Params DSSSign​Params

Параметры подписания
callback @escaping (_ result:​ Result<[DSSSign​Result], Error>) -> Void

Замыкание возвращает результат
result

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

sign​Documents​Offline(documents​IDs:​user:​sign​Params:​callback:​) 

public static func signDocumentsOffline(
        documentsIDs: [String],
        user: DSSUser,
        signParams: DSSSignParams,
        callback: @escaping (_ result: Result<DSSApproveRequest, Error>) -> Void
    )

Подписание документов Offline. Формируется запрос на подпись.

Запускает последовательность экранов SDK: предпросмотр документов, ввод пароля для подписи.

Parameters

documents​IDs [String]

Идентификаторы документов для подписания
user DSSUser

Пользователь, подписывающий документы
sign​Params DSSSign​Params

Параметры подписания
callback @escaping (_ result:​ Result<DSSApprove​Request, Error>) -> Void

Замыкание возвращает результат
result

Возвращает запрос на подписание или ошибку

sign​Documents(approve​Request:​callback:​) 

public static func signDocuments(
        approveRequest: DSSApproveRequest,
        callback: @escaping (_ result: Result<[DSSSignResult], Error>) -> Void
    )

Подписание документов путем отправки заранее подготовленного запроса на подпись

Parameters

approve​Request DSSApprove​Request

Запрос на подпись.
callback @escaping (_ result:​ Result<[DSSSign​Result], Error>) -> Void

Замыкание возвращает результат
result

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

get​Document​Binary​Data(document​Id:​user:​callback:​) 

public static func getDocumentBinaryData(
        documentId: String,
        user: DSSUser,
        callback: @escaping (_ result: Result<URL, Error>) -> Void
    )

Получение бинарных данных документа с сервера

Данный метод позволяет получить бинарные данные документа, загруженного на сервер или подписанного на сервере. Метод скачивает данные, записывает их в кеш приложения и возвращает ссылку. При повторном вызове метода сразу возвращаются закешированые данные. При получении подписанного документа, параметр documentID можно взять из результатов подписи DSSSignResult.

Parameters

document​Id String

Идентификатор документа
user DSSUser

Пользователь-владелец документа
callback @escaping (_ result:​ Result<URL, Error>) -> Void

Замыкание возвращает результат
result

Возвращает ссылку на скачаные бинарные данные или ошибку