PayControl
Instance Methods | Class Methods | List of all members
PayControlSDK Class Reference

#import <PayControlSDK.h>

Inheritance diagram for PayControlSDK:

Instance Methods

(void) - listKeys:
 
(BOOL) - isEmpty
 
(NSInteger) - getKeysCount
 
(PCError *) - deleteKeyWithID:
 
(void) - calculateConfirmationCode:key:fingerprint:completion:
 
(NSString *) - getFingerPrint:
 
(void) - exportKey:completion:
 
(PCError *) - clear
 
(void) - getTransactionInfo:completion:
 
(void) - getFullTransactionInfo:completion:
 
(void) - scanQRFromViewController:animated:textToShow:invalidCodeText:qrType:
 

Class Methods

(PayControlSDK *) + sharedInstance
 

Detailed Description

PayControlSDK class

Method Documentation

- (void) calculateConfirmationCode: (NSString *)  data
key: (PCKey *)  key
fingerprint: (NSString *)  fingerprint
completion: (void(^)(PCError *error, NSString *confirmationCode))  completion 

Генерация кода подтверждения

Parameters
key- Ключ для формирования кода подтверждения. Handle ключевой информации должен иметь валидное значение
data- Данные для подтверждения
fingerprint- Отпечаток устройства. Если fingerprint != NULL, то отпечаток участвует в формировании кода подтверждения
completion- block, возвращает параметры в место вызова метода.
Returns
error - Ошибка выполнения метода. Если error = nil, то метод выполнился успешно
confirmationCode - Сгенерированный код для подтверждения транзакции
- (PCError *) clear

Освобождение ключевой информации всех ключей. Handle ключей принимает нулевое значение

Returns
error - ошибка. Если error = nil, то освобождение прошло успешно.
- (PCError *) deleteKeyWithID: (NSString *)  keyID

Удаление ключа из хранилища

Parameters
keyID- Идентификатор ключевой информации в хранилище PayControl
Returns
error - ошибка. Если error = nil, то удаление завершилось успешно
- (void) exportKey: (NSString *)  keyID
completion: (void(^)(PCError *error, NSString *exportedKey))  completion 

Экспорт ключа

Parameters
keyID- Идентификатор ключевой информации в хранилище PayControl
completion- block, возвращает параметры в место вызова метода.
Returns
error - Ошибка выполнения метода. Если error = nil, то метод выполнился успешно
exportedKey - Экспортированный ключ в XML-формате
- (NSString *) getFingerPrint: (NSInteger)  fingerprintLength

Формирование отпечатка устройства

Parameters
fingerprintLength- Длина отпечатка устройства <= 64 символов (32 байта в виде hex-строки)
Returns
Отпечаток устройства
- (void) getFullTransactionInfo: (NSString *)  data
completion: (void(^)(PCError *error, NSString *userId, NSString *transactionText, NSString *prefixSignatureText, NSString *signatureText, NSString *additionalText))  completion 

Получение данных о транзакции

Parameters
data- Данные транзакции
completion- block, возвращает параметры в место вызова метода.
Returns
error - Ошибка выполнения метода. Если error = nil, то метод выполнился успешно
userId - Идентификатор пользователя
transactionText - Текст транзакции для подтверждения
prefixSignatureText - Текст префикса электронной подписи транзакции
signatureText - Текст электронной подписи транзакции
additionalText - Текст дополнительной информации (при наличии)
- (NSInteger) getKeysCount

Возвращает количество ключей в базе данных

Returns
Количество ключей
- (void) getTransactionInfo: (NSString *)  data
completion: (void(^)(PCError *error, NSString *transactionInfo, NSString *signatureText))  completion 

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

Parameters
data- Данные транзакции
completion- block, возвращает параметры в место вызова метода.
Returns
error - Ошибка выполнения метода. Если error = nil, то метод выполнился успешно
transactionInfo - Информация о транзакции
signatureText - Текст электронной подписи транзакции
- (BOOL) isEmpty

Проверяет, есть ли ключи в базе данных

Returns
YES, если ключей в базе нет
- (void) listKeys: (void(^)(PCError *error, NSArray *array))  completion

Перечисление доступных наборов ключевой информации

Parameters
completion- block, возвращает параметры в место вызова метода.
Returns
array - массив описаний ключевой информации (PCKeyInfo)
error - Ошибка выполнения метода. Если error = nil, то метод выполнился успешно
- (void) scanQRFromViewController: (UIViewController< SSQRCodeReaderDelegate > *)  vc
animated: (BOOL)  animated
textToShow: (NSString *)  textToShow
invalidCodeText: (NSString *)  invalidCodeText
qrType: (NSInteger)  qrType 

Запуск сканера.

Parameters
vc- Контроллер, который отображает контроллер сканера. Контроллер назначается делегатом протокола SSQRCodeReaderDelegate. В нем нужно будет реализовать функции обратного вызова протокола SSQRCodeReaderDelegate:
-(void)scanningCancelled:(SSQRCodeReader *)withController
{
}
-(void)codeDidRecognized:(NSString*)recognizedString withController:(SSQRCodeReader*)withController {
// recognizedString - значение QR кода
}
Parameters
animated- YES - показ сканера с анимацией, NO - без анимации
textToShow- Информационный текст
invalidCodeText- Текст, который показывается при сканировании неверного QR кода
qrType- тип сканируемого QR кода: 0 – сканирование QR кода транзакции, 1 – ключа. Нужно для того, чтобы сканер показывал ошибку, если происходит сканирование не кода транзакции, а кода ключа, для qrType = 0. И наоборот для qrType = 1
+ (PayControlSDK *) sharedInstance

Экземпляр синглетона. Все обращаения к методам и переменным SDK должны происходить через него.


The documentation for this class was generated from the following file: