PayControl
Instance Methods | Properties | List of all members
PCKey Class Reference

#import <PCKey.h>

Inheritance diagram for PCKey:

Instance Methods

(BOOL) - hasValidHandle
 
(PCError *) - importFromQRValue:
 
(PCError *) - importFromStorage:
 
(PCError *) - importFromXML:
 
(PCError *) - isCompleted
 
(PCError *) - store:password:
 
(PCError *) - combineKey:
 
(PCError *) - submitPassword:
 
(PCError *) - updatePassword:oldPassword:newPassword:
 
(PCError *) - resetHandle
 

Properties

NSString * userID
 
NSString * expirationDate
 
NSString * keyName
 
NSString * keyID
 
NSString * handle
 

Detailed Description

структура описания ключевой информации в хранилище

Method Documentation

- (PCError *) combineKey: (NSString *)  keyPart

Добавление второй части ключа

Parameters
keyPart- Вторая часть ключа
Returns
error - ошибка. Если error = nil, то добавление второй части ключа завершилось успешно
- (BOOL) hasValidHandle

Проверка на возможность использования Handle для формирования кода подтверждения

- (PCError *) importFromQRValue: (NSString *)  qrValue

Импорт ключа из данных QR-кода.

Parameters
qrValue- Данные QR-кода
Returns
error - ошибка. Если error = nil, то импорт завершился успешно
- (PCError *) importFromStorage: (NSString *)  keyID

Заполнение ключа из хранилища PayControl. Handle ключевой информации имеет нулевое значение

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

Импорт ключа в XML-формате. Handle ключевой информации имеет нулевое значение.

Parameters
exportedKey- Экспортированный ключ в XML-формате
Returns
error - ошибка. Если error = nil, то импорт завершился успешно
- (PCError *) isCompleted

Проверка на полноту заполнения ключевой информации.

Returns
error - ошибка. Если код ошибки == PC_ERROR_OK, то ключ заполнен полностью. Если код ошибки == PC_ERROR_KEY_IS_NOT_FULL, то необходимо объединение со второй частью ключа
- (PCError *) resetHandle

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

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

Сохранение ключевой информации (полный ключ)

Parameters
keyName- Имя ключевой информации
password- Пароль для ключевой информации
Returns
error - ошибка. Если error = nil, то сохранение завершилось успешно
- (PCError *) submitPassword: (NSString *)  password

Предъявление пароля для получения Handle ключевой информации. В случае успешного ввода пароля Handle становится валидным для использования при генерации кода подтверждения

Parameters
password- пароль
Returns
error - ошибка. Если error = nil, то предъявление пароля прошло успешно.
- (PCError *) updatePassword: (NSString *)  keyID
oldPassword: (NSString *)  oldPassword
newPassword: (NSString *)  newPassword 

Изменение пароля для ключевой информации

Parameters
keyId- Идентификатор ключевой информации в хранилище PayControl
oldPassword- Текущий пароль для ключевой информации
newPassword- Новый пароль для ключевой информации
Returns
error - ошибка. Если error = nil, то обновление пароля прошло успешно.

Property Documentation

- (NSString*) expirationDate
readwritenonatomicstrong

Дата истечения действия ключей

- (NSString*) handle
readwritenonatomicstrong

Handle ключевой информации

- (NSString*) keyID
readwritenonatomicstrong

Идентификатор ключевой информации в хранилище PayControl

- (NSString*) keyName
readwritenonatomicstrong

Имя ключевой информации

- (NSString*) userID
readwritenonatomicstrong

Идентификатор пользователя PayControl


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