PCSDK (PayControl SDK for Android, Version 6.0)

java.lang.Object
- tech.paycon.sdk.v5.PCSDK

public class PCSDK
extends java.lang.Object

PCSDK SDK main class

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class PCSDK.PCQRType
QR-code types to process by PCSDK

Nested Classes
Modifier and Type	Class and Description
`static class`	`PCSDK.PCQRType` QR-code types to process by PCSDK

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`PC_LOG_DEBUG` Log level - debug logs to logcat
`static int`	`PC_LOG_KEY_VALUES` Log level - log key values to logcat.
`static int`	`PC_LOG_VERBOSE` Log level - log key values to logcat.
`static int`	`PC_NO_LOGGING` Log level - no logging

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static PCSDK.PCQRType`	`analyzeQRValue(java.lang.String qrValue)` Function to analyze data from scanned QR-code Should be used to detect if PCSDK can process QR-code data
`static boolean`	`areCallbacksInvokedInMainThread()` Returns the same value as was passed to last call of `setCallbacksInvokedInMainThread(boolean)` or true if this method was never called from the app.
`static boolean`	`checkRoot()` Function to check if device is rooted Returns true if root detected Does not checks if BusyBox presents
`static void`	`clearCaches()` Used for clear caches .
`static Context`	`getContext()` Context given when calling `init(Context)`
`static java.util.Map<java.lang.String,java.lang.String>`	`getCustomHttpHeaders()` Custom headers which was set by last call of `setCustomHttpHeaders(Map)`
`static long`	`getRealTime()` Returns real rime provided by google server
`static java.util.HashMap<java.lang.String,java.lang.String>`	`getSpyAppsList()` Function to build list of potentially dangerous installed apps which include: (1) Apps with PACKAGE_USAGE_STATS and SYSTEM_ALERT_WINDOW privileges excluding system apps (2) Apps from predefined blacklist which might be dangerous Apps with privileges PACKAGE_USAGE_STATS and SYSTEM_ALERT_WINDOW can track active app name in any time and show it's own content over the top This ability is required to make overlay-attack Function excludes following apps: com.sec.android.easyMover com.google.android.apps.nbu.files
`static java.lang.String`	`getVersion()` Returns PCSDK SDK version
`static void`	`init(Context context)` Lib initialization.
`static boolean`	`isInitialized()` Whether PCSDK is properly initialized
`static void`	`removeAllUsers()` Remove all users completely from a device and resets SDK state.
`static void`	`reset()` Resets all handles for all users and resets state.
`static void`	`setAlternativeLogger(AlternativeLogger logger)` Changes the way in which SDK writes log
`static void`	`setCallbacksInvokedInMainThread(boolean isInMainThread)` Defines whether the callbacks passed to various methods which involve interaction with server should be invoked in main thread or not.
`static void`	`setCustomHttpHeaders(java.util.Map<java.lang.String,java.lang.String> customHttpHeaders)` Sets custom HTTP headers which are added to every query to PC External until new headers are set by next call of this function
`static void`	`setFixedApiVersion(boolean isFixed)` Determines whether the API version for a particular `PCUser` is fixed once it has been discovered. By default, the API version is not remembered between the sessions which means that every time before the new session with PC Server is established, the actual API version is being resolved.
`static void`	`setHandlesBackgroundTimeout(int timeout)` Defines maximum period (in milliseconds), during which handles for private keys will be kept while the app in the background.
`static void`	`setLogLevel(int logLevel)` Set PCSDK SDK log level

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
```
    Log level - no logging
    
    See Also:
    
    Constant Field Values
  - PC_LOG_DEBUG
```
public static final int PC_LOG_DEBUG
```
    Log level - debug logs to logcat
    
    See Also:
    
    Constant Field Values
  - PC_LOG_KEY_VALUES
```
public static final int PC_LOG_KEY_VALUES
```
    Log level - log key values to logcat. PC_LOG_DEBUG must be set
    
    See Also:
    
    Constant Field Values
  - PC_LOG_VERBOSE
```
public static final int PC_LOG_VERBOSE
```
    Log level - log key values to logcat. PC_LOG_DEBUG must be set
    
    See Also:
    
    Constant Field Values
- Method Detail
  - init
```
public static void init(Context context)
```
    Lib initialization. Includes time correction with online request to Google servers
    
    Parameters:
    
    context - Application context. Required for access to Android services on behalf of Application
  - setAlternativeLogger
```
public static void setAlternativeLogger(AlternativeLogger logger)
```
    Changes the way in which SDK writes log
    
    Parameters:
    
    logger - Implementation of AlternativeLogger. Methods of this implementation will be called instead of LogCat methods. If you pass null, the LogCat will be used
  - reset
```
public static void reset()
```
    Resets all handles for all users and resets state. init(Context) needs to be called after this method to continue working with SDK
  - removeAllUsers
```
public static void removeAllUsers()
```
    Remove all users completely from a device and resets SDK state. init(Context) needs to be called after this method to continue working with SDK
  - getRealTime
```
public static long getRealTime()
```
    Returns real rime provided by google server
    
    Returns:
    
    Time in milliseconds according to Google server
  - setCallbacksInvokedInMainThread
```
public static void setCallbacksInvokedInMainThread(boolean isInMainThread)
```
    Defines whether the callbacks passed to various methods which involve interaction with server should be invoked in main thread or not. This method is called automatically at initialization with true so that all the callbacks are invoked in main thread. Call this method after init(Context) in case you intend to alter default behaviour.
    Note that SDK always performs requests to the server or any other relatively long operations in a separate thread (asynchronously). This method only influences in which thread the callback will be invoked after method is executed.
    
    Parameters:
    
    isInMainThread - Pass true if you want callbacks to be invoked in main thread. Pass false if you do not care about actual thread where callbacks will be invoked. If false is passed callbacks will be executed either in separate thread (which is created by SDK for interaction with server) or in the same thread where SDK method is called in case the separate thread was not created (e.g. when there is no internet connection and callback returns error of type PCNetError.PCIS_ERROR_NO_CONNECTION).
  - areCallbacksInvokedInMainThread
```
public static boolean areCallbacksInvokedInMainThread()
```
    Returns the same value as was passed to last call of setCallbacksInvokedInMainThread(boolean) or true if this method was never called from the app.
    
    Returns:
    
    Whether the callbacks are invoked in main thread
  - isInitialized
```
public static boolean isInitialized()
```
    Whether PCSDK is properly initialized
  - setLogLevel
```
public static void setLogLevel(int logLevel)
```
    Set PCSDK SDK log level
    
    Parameters:
    
    logLevel - - log level
  - setFixedApiVersion
```
public static void setFixedApiVersion(boolean isFixed)
```
    Determines whether the API version for a particular PCUser is fixed once it has been discovered.
    By default, the API version is not remembered between the sessions which means that every time before the new session with PC Server is established, the actual API version is being resolved. This allows to start using new API version as soon as the server supports it without any additional amendments to the app source code. If this is not what you want, you should call this method before initialization and before calling any other methods and pass true in order to prevent PC SDK from checking whether the new API version is available.
    
    Parameters:
    
    isFixed - true if API version must be fixed across the sessions with PC Server, false if API version is supposed to be checked before every new session
  - checkRoot
```
public static boolean checkRoot()
```
    Function to check if device is rooted
    Returns true if root detected
    Does not checks if BusyBox presents
    
    Returns:
    
    isRooted
  - getCustomHttpHeaders
```
public static java.util.Map<java.lang.String,java.lang.String> getCustomHttpHeaders()
```
    Custom headers which was set by last call of setCustomHttpHeaders(Map)
  - setCustomHttpHeaders
```
public static void setCustomHttpHeaders(java.util.Map<java.lang.String,java.lang.String> customHttpHeaders)
```
    Sets custom HTTP headers which are added to every query to PC External until new headers are set by next call of this function
    
    Parameters:
    
    customHttpHeaders - Map of custom HTTP headers (header name -> header value)
  - getSpyAppsList
```
public static java.util.HashMap<java.lang.String,java.lang.String> getSpyAppsList()
```
    Function to build list of potentially dangerous installed apps which include: (1) Apps with PACKAGE_USAGE_STATS and SYSTEM_ALERT_WINDOW privileges excluding system apps
    (2) Apps from predefined blacklist which might be dangerous
    Apps with privileges PACKAGE_USAGE_STATS and SYSTEM_ALERT_WINDOW can track active app name in any time and show it's own content over the top
    This ability is required to make overlay-attack
    Function excludes following apps:
    com.sec.android.easyMover
    com.google.android.apps.nbu.files
    
    Returns:
    
    HashMap(String packageName, String applicationName)
  - getVersion
```
public static java.lang.String getVersion()
```
    Returns PCSDK SDK version
    
    Returns:
    
    PCSDK SDK version
  - analyzeQRValue
```
public static PCSDK.PCQRType analyzeQRValue(java.lang.String qrValue)
```
    Function to analyze data from scanned QR-code
    Should be used to detect if PCSDK can process QR-code data
    
    Parameters:
    
    qrValue - data from QR-code
    
    Returns:
    
    data type PCSDK.PCQRType
  - getContext
```
public static Context getContext()
```
    Context given when calling init(Context)
    
    Returns:
    
    Context or null
  - setHandlesBackgroundTimeout
```
public static void setHandlesBackgroundTimeout(int timeout)
```
    Defines maximum period (in milliseconds), during which handles for private keys will be kept while the app in the background. If time of being in the background exceeds defined timeout, handles will be removed and regenerated again when needed. If method isn't called, the default timeout of 15000 ms will be used
    
    Parameters:
    
    timeout - max time in milliseconds for being in background during which handles are kept
  - clearCaches
```
public static void clearCaches()
```
    Used for clear caches
    . Should be called periodically (when where are no pending transactions) to free device storage from previously downloaded files with binary data for transactions

Class PCSDK

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

PC_NO_LOGGING

PC_LOG_DEBUG

PC_LOG_KEY_VALUES

PC_LOG_VERBOSE

Method Detail

init

setAlternativeLogger

reset

removeAllUsers

getRealTime

setCallbacksInvokedInMainThread

areCallbacksInvokedInMainThread

isInitialized

setLogLevel

setFixedApiVersion

checkRoot

getCustomHttpHeaders

setCustomHttpHeaders

getSpyAppsList

getVersion

analyzeQRValue

getContext

setHandlesBackgroundTimeout

clearCaches