PayControl (PayControl SDK Android)

java.lang.Object
- com.safetech.paycontrol.sdk.PayControl

```
public class PayControl
extends java.lang.Object
```
Основной класс PayControl SDK - работа с ключами и транзакциями

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`PayControl.PCCodeType` Тип кода для вычисления
`static class`	`PayControl.TypeConfirmation` Тип подтверждения
`static class`	`PayControl.TypeSystem` Тип системы
`static class`	`PayControl.TypeTransaction` Тип транзакции

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`KEYS_MAX_COUNT` Максимальное количество ключей, хранимых в хранилище
`static int`	`PC_LOG_DEBUG` Уровень логирования библиотеки - выводить отладочную информацию в logcat
`static int`	`PC_LOG_KEY_VALUES` Уровень логирования библиотеки - выводить значения ключей в logcat.
`static int`	`PC_NO_LOGGING` Уровень логирования библиотеки - без логирования

Constructor Summary

Constructors
Constructor and Description

PayControl(android.content.Context context)
Конструктор класса

Constructors
Constructor and Description
`PayControl(android.content.Context context)` Конструктор класса

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`calculateConfirmationCode(PCKey key, java.lang.String data, int confirmationCodeLength, PCCalculateConfirmationCodeCallback callback)` Генерация кода подтверждения
`void`	`calculateConfirmationCode(PCKey key, Transaction transaction, int confirmationCodeLength, PCCalculateConfirmationCodeCallback callback)` Генерация кода подтверждения
`void`	`calculateDeclineCode(PCKey key, java.lang.String data, int declineCodeLength, PCCalculateDeclineCodeCallback callback)` Генерация кода отмены транзакции
`void`	`calculateDeclineCode(PCKey key, Transaction transaction, int declineCodeLength, PCCalculateDeclineCodeCallback callback)` Генерация кода отмены транзакции
`void`	`calculateSignature(PCKey key, java.lang.String data, PCCalculateSignatureCallback callback)` Генерация подписи с использованием асимметричной криптографии
`void`	`calculateSignature(PCKey key, Transaction transaction, PCCalculateSignatureCallback callback)` Генерация подписи с использованием асимметричной криптографии
`boolean`	`closeQRScanner()` Закрывает QR сканер
`void`	`deleteKey(java.lang.String keyID, PCSimpleCallback callback)` Удаление ключа из хранилища
`void`	`destroy()` Деструктор класса
`void`	`doGetTransactionData(PCKey key, java.lang.String transactionId, PCISTransactionDataCallback pccallack)` Метод для получения данных транзакции
`void`	`doGetTransactionsList(PCKey key, PCISListTransactionsCallback pccallack)` Метод для получения списка неподтвержденных транзакций для пользователя
`void`	`doRegisterDevice(PCKey key, java.lang.String deviceToken, PCISSimpleCallback pccallack)` Метод для регистрации токена устройства для пушей
`void`	`doRegisterFingerprint(PCKey key, java.lang.String fingerPrint, PCISSimpleCallback pccallack)` Метод для регистрации отпечатка устройства
`void`	`doRegisterPublicKey(PCKey key, PCISSimpleCallback pccallack)` Метод для регистрации открытого ключа для объекта PCKey Если ранее была сгенерирована ключавая пара, то будет использовано текущее значение В противном случае будет сформирована новая ключевая пара
`void`	`doSendConfirmationCodeByPush(PCKey key, java.lang.String transactionId, java.lang.String fullConfirmationCode, java.lang.String signature, PCISSimpleCallback pccallack)` Метод для подтверждения операции через IS Должно быть установлено значение fullConfirmationCode и, опционально, singature При работе с сервером PayControl настоятельно рекомендуется вычислять значение signature При работе с DSS вычисление signature не поддерживается, и значение указывать не нужно
`void`	`doSendConfirmationCodeByUrl(PCKey key, java.lang.String transactionId, java.lang.String fullConfirmationCode, java.lang.String signature, PCISSimpleCallback pccallack)` Метод для подтверждения операции Online Должно быть установлено значение fullConfirmationCode и, опционально, singature При работе с сервером PayControl настоятельно рекомендуется вычислять значение signature При работе с DSS вычисление signature не поддерживается, и значение указывать не нужно
`void`	`doSendDeclineCodeByPush(PCKey key, java.lang.String transactionId, java.lang.String fullConfirmationCode, PCISSimpleCallback pccallack)` Метод для отправки кода подтверждения через IS
`void`	`doSendDeclineCodeByUrl(PCKey key, java.lang.String transactionId, java.lang.String fullConfirmationCode, PCISSimpleCallback pccallack)` Метод для отправки кода подтверждения Online
`void`	`exportKey(java.lang.String keyID, PCExportKeyCallback callback)` Экспорт ключа
`java.lang.String`	`getFingerPrint(int fingerprintLength)` Формирование отпечатка устройства
`int`	`getKeysCount()` Возвращает количество ключей в базе данных
`java.util.HashMap<java.lang.String,java.lang.String>`	`getSpyAppsList()` Метод для формирования списка приложений с запросом на разрешения PACKAGE_USAGE_STATS и SYSTEM_ALERT_WINDOW, за исключением системных приложений Приложения с такими разрешениеми имеют возможность отслеживать название запущенного в любой момент времени приложения и выводить собственное содержание поверх него, что необходимо для выполнения Overlay-атаки (перекрытия окна) Функция не добавляет в список следующие приложения: com.sec.android.easyMover - https://play.google.com/store/apps/details ?
`void`	`getTransactionInfo(java.lang.String data, PCTransactionInfoCallback callback)` Получение информации о транзакции.
`PCKey`	`importFromQRValue(java.lang.String qrData)` Импорт ключа из данных QR-кода.
`PCKey`	`importFromStorage(java.lang.String keyID)` Заполнение ключа из хранилища PayControl.
`PCKey`	`importFromXML(java.lang.String exportedKey)` Импорт ключа в XML-формате.
`boolean`	`isEmpty()` Проверяет, есть ли ключи в базе данных
`boolean`	`isRooted()` Метод проверки аппарата на рут-права Если вернется true, значит аппарат рутован При проверке не учитывается наличие BusyBox
`void`	`listKeys(PCListKeysCallback callback)` Перечисление доступных наборов ключевой информации
`void`	`pause()` Используется для сохранения сессий ключей
`void`	`processActivityResult(int requestCode, int resultCode, android.content.Intent data, PCQRScanResultCallback callback)` Обработка результатов вызовов служебных Activity (QR-сканер).
`void`	`resume()` Используется для восстановления сессий ключей и проверки их валидности
`void`	`scanQR(java.lang.String title, java.lang.String textToShow, java.lang.String localizationMsgs, android.app.Activity activity, PCProcessQRScanResultCallback callback)` Сканирование QR-кода.
`void`	`setLogging(int logLevel)` Установка уровня логирования библиотеки.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - PC_NO_LOGGING
```
public static final int PC_NO_LOGGING
```
    Уровень логирования библиотеки - без логирования
    
    See Also:
    
    Constant Field Values
  - PC_LOG_DEBUG
```
public static final int PC_LOG_DEBUG
```
    Уровень логирования библиотеки - выводить отладочную информацию в logcat
    
    See Also:
    
    Constant Field Values
  - PC_LOG_KEY_VALUES
```
public static final int PC_LOG_KEY_VALUES
```
    Уровень логирования библиотеки - выводить значения ключей в logcat. Требуется PC_LOG_DEBUG
    
    See Also:
    
    Constant Field Values
  - KEYS_MAX_COUNT
```
public static int KEYS_MAX_COUNT
```
    Максимальное количество ключей, хранимых в хранилище
- Constructor Detail
  - PayControl
```
public PayControl(android.content.Context context)
```
    Конструктор класса
    
    Parameters:
    
    context - Контекст приложения
- Method Detail
  - destroy
```
public void destroy()
```
    Деструктор класса
  - setLogging
```
public void setLogging(int logLevel)
```
    Установка уровня логирования библиотеки. Лог выводится в logCat
    ! при сборке релизной версии отключайте логирование
    
    Parameters:
    
    logLevel - Уровень логирования PC_NO_LOGGING, PC_LOG_DEBUG, PC_LOG_KEY_VALUES
    Значения могут использоваться через логическое ИЛИ
  - resume
```
public void resume()
```
    Используется для восстановления сессий ключей и проверки их валидности
  - pause
```
public void pause()
```
    Используется для сохранения сессий ключей
  - isEmpty
```
public boolean isEmpty()
```
    Проверяет, есть ли ключи в базе данных
    
    Returns:
    
    true, если ключей в базе нет
  - getKeysCount
```
public int getKeysCount()
```
    Возвращает количество ключей в базе данных
    
    Returns:
    
    Количество ключей
  - scanQR
```
public void scanQR(java.lang.String title,
                   java.lang.String textToShow,
                   java.lang.String localizationMsgs,
                   android.app.Activity activity,
                   PCProcessQRScanResultCallback callback)
```
    Сканирование QR-кода. Метод запускает Activity со сканером. Для обработки результата необходимо добавить в onActivityResult вашего Activity метод PayControl.processQRScanResult()
    
    Parameters:
    
    title - Заголовок на экране сканирования QR
    
    textToShow - Текст для отображения на экране сканирования QR
    
    localizationMsgs - Строки для локализации
    
    activity - Текущее Activity приложения
    
    callback - Служит для обработки неверных QR кодов
  - processActivityResult
```
public void processActivityResult(int requestCode,
                                  int resultCode,
                                  android.content.Intent data,
                                  PCQRScanResultCallback callback)
```
    Обработка результатов вызовов служебных Activity (QR-сканер). Данная функция должна быть вызвана из метода onActivityResult того Activity, которое было указано в методе PayControl.scanQR()
    
    Parameters:
    
    requestCode - Используется, чтобы определить от кого вернулся результат
    
    resultCode - Код возврата. Определяет успешно прошел вызов или нет.
    
    data - Intent, в котором возвращаются данные
    
    callback - Callback выполнения функции. Возвращает данные QR-кода и true, если это ключ (false, если это транзакция), либо ошибку (для QR-сканера) PCQRScanResultCallback
  - closeQRScanner
```
public boolean closeQRScanner()
```
    Закрывает QR сканер
    
    Returns:
    
    Показывает, закрылся ли QR сканер
  - listKeys
```
public void listKeys(PCListKeysCallback callback)
```
    Перечисление доступных наборов ключевой информации
    
    Parameters:
    
    callback - Callback выполнения функции. Возвращает массив описаний ключевой информации, либо ошибку PCListKeysCallback
  - exportKey
```
public void exportKey(java.lang.String keyID,
                      PCExportKeyCallback callback)
```
    Экспорт ключа
    
    Parameters:
    
    keyID - Идентификатор ключевой информации в хранилище PayControl
    
    callback - Callback выполнения функции. Возвращает экспортированный ключ в XML-формате PCExportKeyCallback
  - deleteKey
```
public void deleteKey(java.lang.String keyID,
                      PCSimpleCallback callback)
```
    Удаление ключа из хранилища
    
    Parameters:
    
    keyID - Идентификатор ключевой информации в хранилище PayControl
    
    callback - Callback выполнения функции PCSimpleCallback
  - getFingerPrint
```
public java.lang.String getFingerPrint(int fingerprintLength)
```
    Формирование отпечатка устройства
    
    Parameters:
    
    fingerprintLength - DEPRECATED Длина отпечатка устройства <= 64 символов (32 байта в виде hex-строки)
    В библиотеках версии 3.6.2 и выше параметр игнорируется. Используется длина отпечатка 8
    
    Returns:
    
    Отпечаток устройства
  - getTransactionInfo
```
public void getTransactionInfo(java.lang.String data,
                               PCTransactionInfoCallback callback)
```
    Получение информации о транзакции.
    
    Parameters:
    
    data - Данные транзакции
    
    callback - Callback выполнения функции. Возвращает тобъект класса Transaction, либо ошибку PCTransactionInfoCallback
  - calculateConfirmationCode
```
public void calculateConfirmationCode(PCKey key,
                                      java.lang.String data,
                                      int confirmationCodeLength,
                                      PCCalculateConfirmationCodeCallback callback)
```
    Генерация кода подтверждения
    
    Parameters:
    
    key - Ключ для формирования кода подтверждения. Handle ключевой информации должен иметь валидное значение
    
    data - Данные для подтверждения
    
    confirmationCodeLength - Длина кода подтверждения (в десятичных символах)
    
    callback - Callback выполнения функции. Возвращает код подтверждения, либо ошибку PCCalculateConfirmationCodeCallback
  - calculateConfirmationCode
```
public void calculateConfirmationCode(PCKey key,
                                      Transaction transaction,
                                      int confirmationCodeLength,
                                      PCCalculateConfirmationCodeCallback callback)
```
    Генерация кода подтверждения
    
    Parameters:
    
    key - Ключ для формирования кода подтверждения. Handle ключевой информации должен иметь валидное значение
    
    transaction - Транзакция для подтверждения
    
    callback - Callback выполнения функции. Возвращает код подтверждения, либо ошибку
    
    confirmationCodeLength - Длина кода подтверждения (в десятичных символах) PCCalculateConfirmationCodeCallback
  - calculateSignature
```
public void calculateSignature(PCKey key,
                               Transaction transaction,
                               PCCalculateSignatureCallback callback)
```
    Генерация подписи с использованием асимметричной криптографии
    
    Parameters:
    
    key - Ключ для формирования кода подписи. Handle ключа подписи должен иметь валидное значение
    
    transaction - Транзакция для подтверждения
    
    callback - Callback выполнения функции. Возвращает подпись, либо ошибку PCCalculateConfirmationCodeCallback
  - calculateSignature
```
public void calculateSignature(PCKey key,
                               java.lang.String data,
                               PCCalculateSignatureCallback callback)
```
    Генерация подписи с использованием асимметричной криптографии
    
    Parameters:
    
    key - Ключ для формирования кода подписи. Handle ключа подписи должен иметь валидное значение
    
    data - Транзакция для подтверждения
    
    callback - Callback выполнения функции. Возвращает подпись, либо ошибку PCCalculateConfirmationCodeCallback
  - calculateDeclineCode
```
public void calculateDeclineCode(PCKey key,
                                 Transaction transaction,
                                 int declineCodeLength,
                                 PCCalculateDeclineCodeCallback callback)
```
    Генерация кода отмены транзакции
    
    Parameters:
    
    key - Ключ для формирования кода отмены. Handle ключевой информации должен иметь валидное значение
    
    transaction - Транзакция для отмены
    
    callback - Callback выполнения функции. Возвращает код отмены транзакции, либо ошибку
    
    declineCodeLength - Длина кода отмены (в десятичных символах) PCCalculateDeclineCodeCallback
  - calculateDeclineCode
```
public void calculateDeclineCode(PCKey key,
                                 java.lang.String data,
                                 int declineCodeLength,
                                 PCCalculateDeclineCodeCallback callback)
```
    Генерация кода отмены транзакции
    
    Parameters:
    
    key - Ключ для формирования кода отмены. Handle ключевой информации должен иметь валидное значение
    
    data - Данные для отмены
    
    callback - Callback выполнения функции. Возвращает код отмены транзакции, либо ошибку
    
    declineCodeLength - Длина кода отмены (в десятичных символах) PCCalculateDeclineCodeCallback
  - importFromXML
```
public PCKey importFromXML(java.lang.String exportedKey)
```
    Импорт ключа в XML-формате. Handle ключевой информации имеет нулевое значение.
    
    Parameters:
    
    exportedKey - Экспортированный ключ в XML-формате
    
    Returns:
    
    Ключ PCKey
  - importFromQRValue
```
public PCKey importFromQRValue(java.lang.String qrData)
```
    Импорт ключа из данных QR-кода.
    
    Parameters:
    
    qrData - Данные QR-кода
    
    Returns:
    
    Ключ PCKey
  - importFromStorage
```
public PCKey importFromStorage(java.lang.String keyID)
```
    Заполнение ключа из хранилища PayControl. Handle ключевой информации имеет нулевое значение
    
    Parameters:
    
    keyID - Идентификатор ключевой информации в хранилище PayControl
    
    Returns:
    
    Ключ PCKey
  - doSendConfirmationCodeByUrl
```
public void doSendConfirmationCodeByUrl(PCKey key,
                                        java.lang.String transactionId,
                                        java.lang.String fullConfirmationCode,
                                        java.lang.String signature,
                                        PCISSimpleCallback pccallack)
```
    Метод для подтверждения операции Online
    Должно быть установлено значение fullConfirmationCode и, опционально, singature
    При работе с сервером PayControl настоятельно рекомендуется вычислять значение signature
    При работе с DSS вычисление signature не поддерживается, и значение указывать не нужно
    
    Parameters:
    
    key - Объект ключа
    
    transactionId - Идентификатор транзакции
    
    fullConfirmationCode - Код подтверждения
    
    signature - Подпись
    
    pccallack - Callback
  - doSendConfirmationCodeByPush
```
public void doSendConfirmationCodeByPush(PCKey key,
                                         java.lang.String transactionId,
                                         java.lang.String fullConfirmationCode,
                                         java.lang.String signature,
                                         PCISSimpleCallback pccallack)
```
    Метод для подтверждения операции через IS
    Должно быть установлено значение fullConfirmationCode и, опционально, singature
    При работе с сервером PayControl настоятельно рекомендуется вычислять значение signature
    При работе с DSS вычисление signature не поддерживается, и значение указывать не нужно
    
    Parameters:
    
    key - Объект ключа
    
    transactionId - Идентификатор транзакции
    
    fullConfirmationCode - Код подтверждения
    
    signature - Подпись
    
    pccallack - Callback
  - doSendDeclineCodeByUrl
```
public void doSendDeclineCodeByUrl(PCKey key,
                                   java.lang.String transactionId,
                                   java.lang.String fullConfirmationCode,
                                   PCISSimpleCallback pccallack)
```
    Метод для отправки кода подтверждения Online
    
    Parameters:
    
    key - Объект ключа
    
    transactionId - Идентификатор транзакции
    
    fullConfirmationCode - Код подтверждения
    
    pccallack - Callback
  - doSendDeclineCodeByPush
```
public void doSendDeclineCodeByPush(PCKey key,
                                    java.lang.String transactionId,
                                    java.lang.String fullConfirmationCode,
                                    PCISSimpleCallback pccallack)
```
    Метод для отправки кода подтверждения через IS
    
    Parameters:
    
    key - Объект ключа
    
    transactionId - Идентификатор транзакции
    
    fullConfirmationCode - Код подтверждения
    
    pccallack - Callback
  - doGetTransactionsList
```
public void doGetTransactionsList(PCKey key,
                                  PCISListTransactionsCallback pccallack)
```
    Метод для получения списка неподтвержденных транзакций для пользователя
    
    Parameters:
    
    key - Объект ключа
    
    pccallack - Callback со списком транзакций
  - doGetTransactionData
```
public void doGetTransactionData(PCKey key,
                                 java.lang.String transactionId,
                                 PCISTransactionDataCallback pccallack)
```
    Метод для получения данных транзакции
    
    Parameters:
    
    key - Объект ключа
    
    transactionId - Идентификатор транзакции
    
    pccallack - Callback с транзакцией
  - doRegisterFingerprint
```
public void doRegisterFingerprint(PCKey key,
                                  java.lang.String fingerPrint,
                                  PCISSimpleCallback pccallack)
```
    Метод для регистрации отпечатка устройства
    
    Parameters:
    
    key - Объект ключа
    
    fingerPrint - DEPRECATED Отпечаток устройства
    В библиотеках версии 3.6.2 и выше параметр игнорируется, отпечаток вычисляется автоматически
    
    pccallack - Callback
  - doRegisterDevice
```
public void doRegisterDevice(PCKey key,
                             java.lang.String deviceToken,
                             PCISSimpleCallback pccallack)
```
    Метод для регистрации токена устройства для пушей
    
    Parameters:
    
    key - Объект ключа
    
    deviceToken - токен устройства
    
    pccallack - Callback
  - doRegisterPublicKey
```
public void doRegisterPublicKey(PCKey key,
                                PCISSimpleCallback pccallack)
```
    Метод для регистрации открытого ключа для объекта PCKey
    Если ранее была сгенерирована ключавая пара, то будет использовано текущее значение
    В противном случае будет сформирована новая ключевая пара
    
    Parameters:
    
    key - Объект ключа
    
    pccallack - Callback
  - isRooted
```
public boolean isRooted()
```
    Метод проверки аппарата на рут-права
    Если вернется true, значит аппарат рутован
    При проверке не учитывается наличие BusyBox
    
    Returns:
    
    isRooted
  - getSpyAppsList
```
public java.util.HashMap<java.lang.String,java.lang.String> getSpyAppsList()
```
    Метод для формирования списка приложений с запросом на разрешения PACKAGE_USAGE_STATS и SYSTEM_ALERT_WINDOW,
    за исключением системных приложений
    Приложения с такими разрешениеми имеют возможность отслеживать название запущенного
    в любой момент времени приложения и выводить собственное содержание поверх него,
    что необходимо для выполнения Overlay-атаки (перекрытия окна)
    
    Функция не добавляет в список следующие приложения:
    com.sec.android.easyMover - https://play.google.com/store/apps/details ? id = com.sec.android.easyMover
    
    Returns:
    
    HashMap(String packageName, String applicationName)

Class PayControl

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

PC_NO_LOGGING

PC_LOG_DEBUG

PC_LOG_KEY_VALUES

KEYS_MAX_COUNT

Constructor Detail

PayControl

Method Detail

destroy

setLogging

resume

pause

isEmpty

getKeysCount

scanQR

processActivityResult

closeQRScanner

listKeys

exportKey

deleteKey

getFingerPrint

getTransactionInfo

calculateConfirmationCode

calculateConfirmationCode

calculateSignature

calculateSignature

calculateDeclineCode

calculateDeclineCode

importFromXML

importFromQRValue

importFromStorage

doSendConfirmationCodeByUrl

doSendConfirmationCodeByPush

doSendDeclineCodeByUrl

doSendDeclineCodeByPush

doGetTransactionsList

doGetTransactionData

doRegisterFingerprint

doRegisterDevice

doRegisterPublicKey

isRooted

getSpyAppsList