VGSCollect Class Reference

Custom HTTP Headers

customHeaders
Set your custom HTTP headers.
Declaration
Swift

public var customHeaders: [String : String]? { get set }
Show on GitHub

Observe VGSTextField states

observeFieldState
Observe only focused VGSTextField on editing events.
Declaration
Swift

public var observeFieldState: ((_ textField: VGSTextField) -> Void)?
Show on GitHub
observeStates
Observe all VGSTextField on editing events.
Declaration
Swift

public var observeStates: ((_ form: [VGSTextField]) -> Void)?
Show on GitHub

Get Registered VGSTextFields

textFields
Returns array of VGSTextFields associated with VGSCollect instance.
Declaration
Swift

public var textFields: [VGSTextField] { get }
Show on GitHub

Initialization


                    
                    
                    init(id:environment:hostname:satellitePort:)

Initialization.

Declaration

Swift

public init(id: String, environment: String, hostname: String? = nil, satellitePort: Int? = nil)

Parameters

`id`	`String` object, your organization vault id.
`environment`	`String` object, your organization vault environment with data region.(e.g. “live”, “live-eu1”, “sandbox”).
`hostname`	`String?` object, custom Hostname, if not set, data will be sent to Vault Url. Default is `nil`.
`satellitePort`	`Int?` object, custom port for satellite configuration. Default is `nil`. IMPORTANT! Use only with .sandbox environment! Hostname should be specified for valid http://localhost or in local IP format http://192.168.X.X.

Show on GitHub


                    
                    
                    init(id:environment:dataRegion:hostname:satellitePort:)

Initialization.

Declaration

Swift

public convenience init(id: String, environment: Environment = .sandbox, dataRegion: String? = nil, hostname: String? = nil, satellitePort: Int? = nil)

Parameters

`id`	`String` object, your organization vault id.
`environment`	`Environment` object, your organization vault environment. By default `Environment.sandbox`.
`dataRegion`	`String` object, id of data storage region (e.g. “eu-123”).
`hostname`	`String` object, custom Hostname, if not set, data will be sent to Vault Url. Default is `nil`.
`satellitePort`	`Int?` object, custom port for satellite configuration. Default is `nil`. IMPORTANT! Use only with .sandbox environment! Hostname should be specified for valid http://localhost or in local IP format http://192.168.X.X.

Show on GitHub

Manage VGSTextFields

getTextField(fieldName:)
Returns VGSTextField with VGSConfiguration.fieldName associated with VGCollect instance.
Declaration
Swift

public func getTextField(fieldName: String) -> VGSTextField?
Show on GitHub


                    
                    
                    unsubscribeTextField(_:)

Unasubscribe VGSTextField from VGSCollect instance.

Declaration

Swift

public func unsubscribeTextField(_ textField: VGSTextField)

Parameters


                                textField

VGSTextField that should be unsubscribed.

Show on GitHub


                    
                    
                    unsubscribeTextFields(_:)

Unasubscribe VGSTextFields from VGSCollect instance.

Declaration

Swift

public func unsubscribeTextFields(_ textFields: [VGSTextField])

Parameters


                                textFields

an array of VGSTextFields that should be unsubscribed.

Show on GitHub

unsubscribeAllTextFields()
Unasubscribe all VGSTextFields from VGSCollect instance.
Declaration
Swift

public func unsubscribeAllTextFields()
Show on GitHub

Manage Files

cleanFiles()
Detach files for associated VGSCollect instance.
Declaration
Swift

public func cleanFiles()
Show on GitHub

Send data


                    
                    
                    sendData(path:method:routeId:extraData:requestOptions:completion:)

Send data from VGSTextFields to your organization vault.

Note

Errors can be returned in the NSURLErrorDomain and VGSCollectSDKErrorDomain.

Declaration

Swift

public func sendData(path: String, method: VGSCollectHTTPMethod = .post, routeId: String? = nil, extraData: [String : Any]? = nil, requestOptions: VGSCollectRequestOptions = VGSCollectRequestOptions(), completion block: @escaping (VGSResponse) -> Void)

Parameters

`path`	Inbound rout path for your organization vault.
`method`	VGSCollectHTTPMethod, default is `.post`.
`routeId`	id of VGS Proxy Route, default is `nil`.
`extraData`	Any data you want to send together with data from VGSTextFields , default is `nil`.
`requestOptions`	`VGSCollectRequestOptions` object, holds additional request options. Default options are `.nestedJSON`.
`completion`	response completion block, returns `VGSResponse`.

Show on GitHub


                    
                    
                    sendFile(path:method:routeId:extraData:requestOptions:completion:)

Send file to your organization vault. Only send one file at a time.

Note

Errors can be returned in the NSURLErrorDomain and VGSCollectSDKErrorDomain.

Declaration

Swift

public func sendFile(path: String, method: VGSCollectHTTPMethod = .post, routeId: String? = nil, extraData: [String : Any]? = nil, requestOptions: VGSCollectRequestOptions = VGSCollectRequestOptions(), completion block: @escaping (VGSResponse) -> Void)

Parameters

`path`	Inbound rout path for your organization vault.
`method`	HTTPMethod, default is `.post`.
`routeId`	id of VGS Proxy Route, default is `nil`.
`extraData`	Any data you want to send together with data from VGSTextFields , default is `nil`.
`completion`	response completion block, returns `VGSResponse`.

Show on GitHub


                    
                    
                    tokenizeData(routeId:completion:)

Send tokenization request with data from VGSTextFields.

Note

Errors can be returned in the NSURLErrorDomain and VGSCollectSDKErrorDomain.

Declaration

Swift

public func tokenizeData(routeId: String? = nil, completion block: @escaping (VGSTokenizationResponse) -> Void)

Parameters

`routeId`	id of VGS Proxy Route, default is `nil`.
`completion`	response completion block, returns `VGSTokenizationResponse`.

Show on GitHub

VGSCollect + async


                    
                    
                    sendData(path:method:routeId:extraData:requestOptions:)

Asynchronous

Asynchronously send data from VGSTextFields to your organization vault.

Note

Errors can be returned in the NSURLErrorDomain and VGSCollectSDKErrorDomain.

Declaration

Swift

public func sendData(path: String, method: VGSCollectHTTPMethod = .post, routeId: String? = nil, extraData: [String : Any]? = nil, requestOptions: VGSCollectRequestOptions = VGSCollectRequestOptions()) async -> VGSResponse

Parameters

`path`	Inbound rout path for your organization vault.
`method`	VGSCollectHTTPMethod, default is `.post`.
`routeId`	id of VGS Proxy Route, default is `nil`.
`extraData`	Any data you want to send together with data from VGSTextFields , default is `nil`.
`requestOptions`	`VGSCollectRequestOptions` object, holds additional request options. Default options are `.nestedJSON`.

Return Value

Show on GitHub


                    
                    
                    sendFile(path:method:routeId:extraData:)

Asynchronous

Asynchronously send file to your organization vault. Only send one file at a time.

Note

Errors can be returned in the NSURLErrorDomain and VGSCollectSDKErrorDomain.

Declaration

Swift

public func sendFile(path: String, method: VGSCollectHTTPMethod = .post, routeId: String? = nil, extraData: [String : Any]? = nil) async -> VGSResponse

Parameters

`path`	Inbound rout path for your organization vault.
`method`	HTTPMethod, default is `.post`.
`routeId`	id of VGS Proxy Route, default is `nil`.
`extraData`	Any data you want to send together with data from VGSTextFields , default is `nil`.
`completion`	response completion block, returns `VGSResponse`.

Show on GitHub


                    
                    
                    tokenizeData(routeId:)

Asynchronous

Asynchronously send tokenization request with data from VGSTextFields.

Note

Errors can be returned in the NSURLErrorDomain and VGSCollectSDKErrorDomain.

Declaration

Swift

public func tokenizeData(routeId: String? = nil) async -> VGSTokenizationResponse

Parameters

`routeId`	id of VGS Proxy Route, default is `nil`.
`completion`	response completion block, returns `VGSTokenizationResponse`.

Show on GitHub

VGSCollect + Combine


                    
                    
                    sendDataPublisher(path:method:routeId:extraData:requestOptions:)

Send data from VGSTextFields to your organization vault using the Combine framework.

Note

Errors can be returned in the NSURLErrorDomain and VGSCollectSDKErrorDomain.

Declaration

Swift

public func sendDataPublisher(path: String, method: VGSCollectHTTPMethod = .post, routeId: String? = nil, extraData: [String : Any]? = nil, requestOptions: VGSCollectRequestOptions = VGSCollectRequestOptions()) -> Future<VGSResponse, Never>

Parameters

`path`	Inbound rout path for your organization vault.
`method`	VGSCollectHTTPMethod, default is `.post`.
`routeId`	id of VGS Proxy Route, default is `nil`.
`extraData`	Any data you want to send together with data from VGSTextFields , default is `nil`.
`requestOptions`	`VGSCollectRequestOptions` object, holds additional request options. Default options are `.nestedJSON`.

Return Value

A Future publisher that emits a single VGSResponse.

Show on GitHub


                    
                    
                    sendFilePublisher(path:method:routeId:extraData:requestOptions:)

Send file to your organization vault using the Combine framework.

Note

Errors can be returned in the NSURLErrorDomain and VGSCollectSDKErrorDomain.

Declaration

Swift

public func sendFilePublisher(path: String, method: VGSCollectHTTPMethod = .post, routeId: String? = nil, extraData: [String : Any]? = nil, requestOptions: VGSCollectRequestOptions = VGSCollectRequestOptions()) -> Future<VGSResponse, Never>

Parameters

`path`	Inbound rout path for your organization vault.
`method`	VGSCollectHTTPMethod, default is `.post`.
`routeId`	id of VGS Proxy Route, default is `nil`.
`extraData`	Any data you want to send together with data from VGSTextFields , default is `nil`.
`requestOptions`	`VGSCollectRequestOptions` object, holds additional request options. Default options are `.nestedJSON`.

Return Value

A Future publisher that emits a single VGSResponse.

Show on GitHub


                    
                    
                    tokenizeDataPublisher(routeId:)

Send tokenization request with data from VGSTextFields to your organization vault using the Combine framework.

Note

Errors can be returned in the NSURLErrorDomain and VGSCollectSDKErrorDomain.

Declaration

Swift

public func tokenizeDataPublisher(routeId: String? = nil) -> Future<VGSTokenizationResponse, Never>

Parameters


                                routeId

id of VGS Proxy Route, default is nil.

Return Value

A Future publisher that emits a single VGSTokenizationResponse.

Show on GitHub