vgscollect/com.verygoodsecurity.vgscollect.core/VGSCollect

VGSCollect

VGS Collect allows you to securely collect data and files from your users without having to have them pass through your systems. Entry-point to the Collect SDK.

Since

1.0.0

Constructors

VGSCollect

constructor(context: Context, id: String, environment: String)

constructor(context: Context, id: String, environment: Environment = Environment.SANDBOX)

constructor(context: Context, id: String, environmentType: String, suffix: String)

Types

Builder

class Builder(context: Context, id: String)

Used to create VGSCollect instances with default and overridden settings.

Functions

addOnFieldStateChangeListener

fun addOnFieldStateChangeListener(fieldStateListener: OnFieldStateChangeListener?)

This method adds a listener whose methods are called whenever VGS secure fields state changes.

addOnResponseListeners

fun addOnResponseListeners(onResponseListener: VgsCollectResponseListener?)

Adds a listener to the list of those whose methods are called whenever the VGSCollect receive response from Server.

asyncSubmit

fun asyncSubmit(request: VGSRequest)

fun asyncSubmit(path: String, method: HTTPMethod)

This method executes and send data on VGS Server.

bindView

fun bindView(view: InputFieldView?)

fun bindView(vararg views: InputFieldView?)

Allows VGS secure fields to interact with VGSCollect and collect data from this source.

clearResponseListeners

fun clearResponseListeners()

Clear all response listeners attached before.

createAliases

fun createAliases()

fun createAliases(request: VGSCreateAliasesRequest)

The method sends data on VGS Server for create aliases.

getAllStates

fun getAllStates(): List<FieldState>

Returns the states of all fields bound before to VGSCollect.

getFileProvider

fun getFileProvider(): VGSFileProvider

Return instance for managing attached files to request.

getIsAnalyticsEnabled

fun getIsAnalyticsEnabled(): Boolean

onActivityResult

fun onActivityResult(requestCode: Int, resultCode: Int, data: Intent?)

Called when an activity you launched exits, giving you the requestCode you started it with, the resultCode is returned, and any additional data for VGSCollect. Preferably call it inside onActivityResult system's callback.

onDestroy

fun onDestroy()

Clear all information collected before by VGSCollect. Preferably call it inside onDestroy system's callback.

removeOnResponseListener

fun removeOnResponseListener(onResponseListener: VgsCollectResponseListener)

Clear specific listener attached before.

resetCustomData

fun resetCustomData()

Reset all static custom data which added before. This method has no impact on all custom data that were added with VGSRequest

resetCustomHeaders

fun resetCustomHeaders()

Reset all static headers which added before. This method has no impact on all custom data that were added with VGSRequest

setAnalyticsEnabled

fun setAnalyticsEnabled(isEnabled: Boolean)

If you want to disable collecting analytics from VGS Collect SDK, you can set the value to false. This helps us to understand which areas require improvements. No personal information is tracked.

setCustomData

fun setCustomData(data: Map<String, Any>?)

It collect custom data which will be send to server. This is static custom data that are stored and attach for all requests until resetCustomData method will be called.

setCustomHeaders

fun setCustomHeaders(headers: Map<String, String>?)

It collects headers that will be sent to the server. This is static headers that are stored and attach for all requests until @resetCustomHeaders method will be called.

submit

fun submit(request: VGSRequest): VGSResponse

fun submit(path: String, method: HTTPMethod = HTTPMethod.POST): VGSResponse

This method executes and send data on VGS Server. It could be useful if you want to handle multithreading by yourself. Do not use this method on the UI thread as this may crash.

submitAsync

suspend fun submitAsync(request: VGSRequest): VGSResponse

suspend fun submitAsync(path: String, method: HTTPMethod = HTTPMethod.POST): VGSResponse

This suspend method executes and send data on VGS Server on IO dispatcher.

tokenize

fun tokenize()

fun tokenize(request: VGSTokenizationRequest)

The method sends data on VGS Server for tokenization.

unbindView

fun unbindView(view: InputFieldView?)

fun unbindView(vararg views: InputFieldView?)

Allows to unsubscribe from a View updates.