Класс Docs

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

Метод uploadDocumentSuspend (suspend)

Загрузка документа на сервер в простых сценариях с возвращением строкового идентификатора документа.

    suspend fun uploadDocumentSuspend(
        context: Context,
        kid: String,
        document: UploadFile,
    )

Параметры:

Параметр	Тип	Описание
kid	String	Идентификатор набора ключей пользователя
document	UploadFile	Информация о загружаемом на сервер документе

Возвращаемые параметры:

Параметр	Описание
docId	Идентификатор загруженного на сервер документа

Метод uploadDocumentFlow (потоковый, suspend)

Метод позволяет загружать документ в потоковом режиме, отслеживая поток по мере выполнения загрузки. Подходит для сценариев, где требуется отображать прогресс выполнения.

    suspend fun uploadDocumentFlow(
        context: Context,
        kid: String,
        document: UploadFile,
    )

Параметры:

Параметр	Тип	Описание
kid	String	Идентификатор набора ключей пользователя
document	UploadFile	Информация о загружаемом на сервер документе

Возвращаемые параметры:

Параметр	Описание
Flow	Текущее состояние загрузки документа на сервер

Метод uploadDocument

Загрузка документа на сервер без возможности отслеживания прогресса.

    fun uploadDocument(
        context: Context,
        kid: String,
        document: UploadFile,
        callback: SdkResultCallback<String>
    )

Параметры:

Параметр	Тип	Описание
kid	String	Идентификатор набора ключей пользователя
document	UploadFile	Информация о загружаемом на сервер документе
callback	SdkResultCallback<String>	Интерфейс обратного вызова

Возвращаемые параметры:

Параметр	Описание
docId	Идентификатор загруженного на сервер документа

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

Метод downloadDocumentSuspend (suspend)

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

    suspend fun downloadDocumentSuspend(context: Context, kid: String, docId: String)

Параметры:

Параметр	Тип	Описание
kid	String	Идентификатор набора ключей пользователя
docId	String	Идентификатор загруженного на сервер документа

Возвращаемые параметры:

Параметр	Описание
byte[]	Содержимое документа в виде массива байт

Метод downloadDocumentSuspend (запись в файл, suspend)

Получение документа с сервера и запись в переданный файл.

    suspend fun downloadDocumentSuspend(
        context: Context,
        kid: String,
        docId: String,
        file: File
    ) 

Параметры:

Параметр	Тип	Описание
kid	String	Идентификатор набора ключей пользователя
docId	String	Идентификатор загруженного на сервер документа
file	File	Файл, в который необходимо записать полученный документ

Возвращаемые параметры:

Параметр Описание
file

Метод downloadDocumentSuspend (работа с потоком данных, suspend)

Метод позволяет скачивать документ в потоковом режиме. Подходит для загрузки больших файлов.

    suspend fun downloadDocumentSuspend(
        context: Context,
        kid: String,
        docId: String,
        outputStream: OutputStream
    )

Параметры:

Параметр	Тип	Описание
kid	String	Идентификатор набора ключей пользователя
docId	String	Идентификатор документа
outputStream	OutputStream	Поток для записи скачиваемого документа

Возвращаемые параметры:

Параметр	Описание
outputStream	Поток для записи скачиваемого документа

Метод downloadDocument (работа с потоком данных)

Метод позволяет скачивать документ в потоковом режиме. Подходит для загрузки больших файлов.

    suspend fun downloadDocumentSuspend(
        context: Context,
        kid: String,
        docId: String,
        outputStream: OutputStream
    )

Параметры:

Параметр	Тип	Описание
kid	String	Идентификатор набора ключей пользователя
docId	String	Идентификатор документа
outputStream	OutputStream	Поток для записи скачиваемого документа

Возвращаемые параметры:

Параметр	Описание
outputStream	Поток для записи скачиваемого документа

Метод downloadDocument (синхронный)

Выгрузка документа с сервера.

    fun downloadDocument(
        context: Context,
        kid: String,
        docId: String,
        callback: SdkResultCallback<Array<Byte>>
    )

Параметры:

Параметр	Тип	Описание
kid	String	Идентификатор набора ключей пользователя
docId	String	Идентификатор документа
callback	SdkResultCallback<Array<Byte>>	Интерфейс обратного вызова

Возвращаемые параметры:

Параметр	Описание
byte[]	Содержимое документа в виде массива байт

Метод downloadDocument (для обратной совместимости)

Выгрузка документа с сервера.

    fun downloadDocument(
        context: Context,
        kid: String,
        docId: String,
        file: File,
        callback: SdkResultCallback<Unit>
    )

Параметры:

Параметр	Тип	Описание
kid	String	Идентификатор набора ключей пользователя
docId	String	Идентификатор документа
file	File	Файл, в который необходимо записать полученный документ

callback | SdkResultCallback<Unit> | Интерфейс обратного вызова

Возвращаемые параметры:

Параметр	Описание
file	Файл, в который записан полученный документ

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

Метод getDocumentInfo

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

    fun getDocumentInfo(
        context: Context,
        kid: String,
        docId: String,
        sdkResultCallback: SdkResultCallback<DownloadDocInfo>
    )

Параметры:

Параметр	Тип	Описание
kid	String	Идентификатор набора ключей пользователя
docId	String	Идентификатор документа
callback	SdkResultCallback<DownloadDocInfo>	Интерфейс обратного вызова

Возвращаемые параметры:

Параметр	Описание
DownloadDocInfo	Информация о документе

Метод getDocumentInfoSuspend (suspend)

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

    suspend fun getDocumentInfoSuspend(
        context: Context,
        kid: String,
        docId: String
    )

Параметры:

Параметр	Тип	Описание
kid	String	Идентификатор набора ключей пользователя
docId	String	Идентификатор документа

Возвращаемые параметры:

Параметр	Описание
DownloadDocInfo	Информация о документе

Работа с сертификатами и запросами на сертификаты

Метод downloadCertContentSuspend (suspend)

Получение печатной формы сертификата.

    suspend fun downloadCertContentSuspend(
        context: Context,
        cid: String,
        kid: String,
        isShowContent: Boolean,
        isNeedApprove: Boolean,
    )

Параметры:

Параметр	Тип	Описание
cid	Int	Идентификатор сертификата
kid	String	Идентификатор набора ключей пользователя
isShowContent	Boolean	Флаг, указывающий, требуется ли отобразить печатную форму
isNeedApprove	Boolean	Флаг, указывающий, требуется ли отобразить поверх формы кнопки подтверждения/отказа для реализации некоторых сценариев

Возвращаемые параметры:

Параметр	Описание
DownloadedCertificateFile	Сведения о печатной форме

Метод downloadRequestContentSuspend (suspend)

Получение печатной формы запроса на сертификат.

    suspend fun downloadRequestContentSuspend(
        context: Context,
        rid: String,
        kid: String,
        isShowContent: Boolean,
        isNeedApprove: Boolean
    )

Параметры:

Параметр	Тип	Описание
rid	Int	Идентификатор запроса на сертификат
kid	String	Идентификатор набора ключей пользователя
isShowContent	Boolean	Флаг, указывающий, требуется ли отобразить печатную форму
isNeedApprove	Boolean	Флаг, указывающий, требуется ли отобразить поверх формы кнопки подтверждения/отказа для реализации некоторых сценариев

Возвращаемые параметры:

Параметр	Описание
DownloadedCertificateFile	Сведения о печатной форме