tech.paycon.sdk.v5

Class PCUserBackupData

java.lang.Object

tech.paycon.sdk.v5.PCUserBackupData

public class PCUserBackupData
extends java.lang.Object

This class contains as much info as needed to backup and restore the user.
This data type is used in related methods of PCUserRestore class.
Normally, you are not supposed nor to construct any objects of this class neither to call get* and set* methods. Use fromJson(String) and toJson() instead.

Constructor Summary

Constructors

Constructor and Description
PCUserBackupData() Creates an empty object.

Method Summary

Modifier and Type	Method and Description
static PCUserBackupData	fromJson(java.lang.String json) This function imports backup data from json.
long	getCreationTimeMillis() Returns time when backup was created in milliseconds
java.lang.String	getDeviceName() Name of the device on which the backup was created
java.lang.String	getEncodedCodeword()
java.lang.String	getExternalUrl()
java.lang.String	getSystemId()
java.lang.String	getUserId()
java.lang.String	getUserName()
void	setEncodedCodeword(java.lang.String encodedCodeword) Set the encoded codeword which will be decoded with the password, provided by the user when calling PCUserRestore.restoreBackup(PCUserBackupData, String, PCRestoreCallback)
void	setExternalUrl(java.lang.String pcExternalUrl) Set the URL for communication with PCServer
void	setSystemId(java.lang.String pcSystemId) Set the ID of the system for user supposed to be backed up
void	setUserId(java.lang.String pcUserId) Set the ID of the user supposed to be backed up
void	setUserName(java.lang.String pcUserName) Set the name of the key
java.lang.String	toJson() Use this method to save the data as a string and restore when on another device with usage of fromJson(String) and PCUserRestore.restoreBackup(PCUserBackupData, String, PCRestoreCallback)
java.lang.String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

PCUserBackupData

public PCUserBackupData()

Creates an empty object. Normally you shouldn't call the constructor directly. Use fromJson(String) or instance returned by PCUserRestore class when you are creating backup.

Method Detail

fromJson

public static PCUserBackupData fromJson(java.lang.String json)

This function imports backup data from json. You are not supposed to create json by yourself but should use the result of toJson().

Parameters:

json - Json as string which contains all necessary fields

Returns:

PCUserBackupData object ready to be used in PCUserRestore.restoreBackup(PCUserBackupData, String, PCRestoreCallback)

getUserId

public java.lang.String getUserId()

Returns:

saved ID of the user

setUserId

public void setUserId(java.lang.String pcUserId)

Set the ID of the user supposed to be backed up

Parameters:

pcUserId - the ID of the user, which may be acquired through PCUser.getUserId()

getSystemId

public java.lang.String getSystemId()

Returns:

saved ID of the system, the user belongs to

setSystemId

public void setSystemId(java.lang.String pcSystemId)

Set the ID of the system for user supposed to be backed up

Parameters:

pcSystemId - the ID of the system, which may be acquired through PCUser.getSystemId()

getExternalUrl

public java.lang.String getExternalUrl()

Returns:

saved URL for communication with PCServer

setExternalUrl

public void setExternalUrl(java.lang.String pcExternalUrl)

Set the URL for communication with PCServer

Parameters:

pcExternalUrl - the URL, which may be acquired through PCUser.getPCExternalUrl()

getUserName

public java.lang.String getUserName()

Returns:

saved name of the key

setUserName

public void setUserName(java.lang.String pcUserName)

Set the name of the key

Parameters:

pcUserName - the name, which can be acquired through PCUser.getName()

getEncodedCodeword

public java.lang.String getEncodedCodeword()

Returns:

The encoded codeword, which will be used to restore the user. The codeword is encoded with the password, provided by user. See PCUserRestore.createBackupData(PCUser, String, PCUserBackupCallback) for more details.

setEncodedCodeword

public void setEncodedCodeword(java.lang.String encodedCodeword)

Set the encoded codeword which will be decoded with the password, provided by the user when calling PCUserRestore.restoreBackup(PCUserBackupData, String, PCRestoreCallback)

Parameters:

encodedCodeword - Encoded codeword

getCreationTimeMillis

public long getCreationTimeMillis()

Returns time when backup was created in milliseconds

Returns:

Timestamp in milliseconds

getDeviceName

public java.lang.String getDeviceName()

Name of the device on which the backup was created

Returns:

Name of the device

toJson

public java.lang.String toJson()

Use this method to save the data as a string and restore when on another device with usage of fromJson(String) and PCUserRestore.restoreBackup(PCUserBackupData, String, PCRestoreCallback)

Returns:

String which contains all backup data in JSON format

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object