Classes Reference


                    
                    
                    BaseClient

Base class for clients

Declaration

Swift

@objc(VSSBaseClient)
open class BaseClient : NSObject


                    
                    
                    RawServiceError

Model for representing service errors

Declaration

Swift

@objc(VSSRawServiceError)
public final class RawServiceError : NSObject, Codable


                    
                    
                    HttpConnection

Simple HttpConnection implementation

Declaration

Swift

open class HttpConnection : HttpConnectionProtocol


                    
                    
                    NetworkOperation

Network Operation

Declaration

Swift

open class NetworkOperation : GenericOperation<Response>


                    
                    
                    NetworkRetryOperation

Class for network operation with retry

Declaration

Swift

open class NetworkRetryOperation : GenericOperation<Response>


                    
                    
                    Reachability

Reachability

Declaration

Swift

public class Reachability : ReachabilityProtocol


                    
                    
                    Request

Represents Http request

Declaration

Swift

open class Request


                    
                    
                    Response

Represents Http response

Declaration

Swift

open class Response : NSObject


                    
                    
                    ServiceRequest

Class represents HTTP Request to Virgil Service

Declaration

Swift

open class ServiceRequest : Request


                    
                    
                    VirgilAgentAdapter

Class adds virgil-agent header to collect metrics in the Cloud

Declaration

Swift

public final class VirgilAgentAdapter : HttpRequestAdapter


                    
                    
                    ExpBackoffRetry

Class for handling retries for network requests

Declaration

Swift

open class ExpBackoffRetry : RetryProtocol


                    
                    
                    ServiceError

Represent card service error

Declaration

Swift

@objc(VSSServiceError)
open class ServiceError : NSObject, CustomNSError


                    
                    
                    Card

Class representing Virgil Card

Declaration

Swift

@objc(VSSCard)
public class Card : NSObject


                    
                    
                    CardManager

Class responsible for operations with Virgil Cards

Declaration

Swift

@objc(VSSCardManager)
open class CardManager : NSObject


                    
                    
                    CardManagerParams

Contains parameters for initializing CardManager

Declaration

Swift

@objc(VSSCardManagerParams)
public final class CardManagerParams : NSObject


                    
                    
                    CardSignature

Class representing Virgil Card Signature

Declaration

Swift

@objc(VSSCardSignature)
public final class CardSignature : NSObject


                    
                    
                    CardClient

Class representing operations with Virgil Cards service

Declaration

Swift

@objc(VSSCardClient)
open class CardClient : BaseClient

extension CardClient: CardClientProtocol


                    
                    
                    GetCardResponse

Represents response from CardClient’s getCard function with RawSignedModel and whether or not card is outdated

Declaration

Swift

@objc(VSSGetCardResponse)
public final class GetCardResponse : NSObject


                    
                    
                    RawCardContent

Represents content of Virgil Card

Declaration

Swift

@objc(VSSRawCardContent)
public final class RawCardContent : NSObject, Codable


                    
                    
                    RawSignature

Represents signature for RawSignedModel

Declaration

Swift

@objc(VSSRawSignature)
public final class RawSignature : NSObject, Codable


                    
                    
                    RawSignedModel

Represents some model in binary form that can have signatures and corresponds to Virgil Cards Service model

Declaration

Swift

@objc(VSSRawSignedModel)
public final class RawSignedModel : NSObject, Codable


                    
                    
                    ModelSigner

Class responsible for signing RawSignerModel

Declaration

Swift

@objc(VSSModelSigner)
public final class ModelSigner : NSObject


                    
                    
                    VerifierCredentials

Class representing verifier credentials

Declaration

Swift

@objc(VSSVerifierCredentials)
public class VerifierCredentials : NSObject


                    
                    
                    VirgilCardVerifier

Virgil implementation of CardVerifier protocol By default verifies Card’s self signature and Virgil Cards Service signature

Declaration

Swift

@objc(VSSVirgilCardVerifier)
public final class VirgilCardVerifier : NSObject, CardVerifier


                    
                    
                    Whitelist

Class representing collection of verifiers

Important

Card should contain signature from AT LEAST one verifier from collection of verifiers

Declaration

Swift

@objc(VSSWhitelist)
public class Whitelist : NSObject


                    
                    
                    CachingJwtProvider

Implementation of AccessTokenProvider which provides AccessToken using cache+renew callback

Declaration

Swift

@objc(VSSCachingJwtProvider)
open class CachingJwtProvider : NSObject, AccessTokenProvider


                    
                    
                    CallbackJwtProvider

Implementation of AccessTokenProvider which provides AccessToken using callback

Declaration

Swift

@objc(VSSCallbackJwtProvider)
open class CallbackJwtProvider : NSObject, AccessTokenProvider


                    
                    
                    ConstAccessTokenProvider

Implementation of AccessTokenProvider which provides constant AccessToken

Declaration

Swift

@objc(VSSConstAccessTokenProvider)
public final class ConstAccessTokenProvider : NSObject, AccessTokenProvider


                    
                    
                    GeneratorJwtProvider

Implementation of AccessTokenProvider which provides generated JWTs

Declaration

Swift

@objc(VSSGeneratorJwtProvider)
open class GeneratorJwtProvider : NSObject, AccessTokenProvider

Jwt

Class implementing AccessToken in terms of Virgil JWT

Declaration

Swift

@objc(VSSJwt)
public final class Jwt : NSObject, AccessToken


                    
                    
                    JwtBodyContent

Class representing JWT Body content

Declaration

Swift

@objc(VSSJwtBodyContent)
public class JwtBodyContent : NSObject


                    
                    
                    JwtGenerator

Class responsible for JWT generation

Declaration

Swift

@objc(VSSJwtGenerator)
open class JwtGenerator : NSObject


                    
                    
                    JwtHeaderContent

Class representing JWT Header content

Declaration

Swift

@objc(VSSJwtHeaderContent)
public class JwtHeaderContent : NSObject


                    
                    
                    JwtSignatureContent

Class representing JWT Signature content

Declaration

Swift

@objc(VSSJwtSignatureContent)
public final class JwtSignatureContent : NSObject


                    
                    
                    TokenContext

Class used to provide additional info for AccessTokenProvider and explain why token is needed

Declaration

Swift

@objc(VSSTokenContext)
public class TokenContext : NSObject


                    
                    
                    KeyEntry

Undocumented

Declaration

Swift

@objc(VSSKeyEntry)
public class KeyEntry : NSObject, NSCoding


                    
                    
                    KeychainEntry

Class representing Keychain entry

Declaration

Swift

@objc(VSSKeychainEntry)
public final class KeychainEntry : NSObject


                    
                    
                    KeychainQueryOptions

Undocumented

Declaration

Swift

@objc(VSSKeychainQueryOptions)
public class KeychainQueryOptions : NSObject


                    
                    
                    KeychainStorageError

Class respresenting error returned from KeychainStorage

Declaration

Swift

@objc(VSSKeychainStorageError)
public final class KeychainStorageError : NSObject, CustomNSError


                    
                    
                    KeychainStorage

Class responsible for Keychain interactions.

Declaration

Swift

@objc(VSSKeychainStorage)
open class KeychainStorage : NSObject

extension KeychainStorage: KeychainStorageProtocol


                    
                    
                    KeychainStorageParams

Class responsible for KeychainStorage setup

Declaration

Swift

@objc(VSSKeychainStorageParams)
public final class KeychainStorageParams : NSObject


                    
                    
                    SandboxedKeychainStorage

KeychainStorage that sandboxes entries using identity and prefix

Declaration

Swift

@objc(VSSSandboxedKeychainStorage)
public final class SandboxedKeychainStorage : NSObject

extension SandboxedKeychainStorage: KeychainStorageProtocol


                    
                    
                    KeyknoxClient

Class representing operations with Virgil Keyknox service

Declaration

Swift

@objc(VSSKeyknoxClient)
open class KeyknoxClient : BaseClient

extension KeyknoxClient: KeyknoxClientProtocol


                    
                    
                    KeyknoxGetKeysParams

Keyknox get parameters

Declaration

Swift

@objc(VSSKeyknoxGetKeysParams)
public class KeyknoxGetKeysParams : NSObject


                    
                    
                    KeyknoxDeleteRecipientParams

Keyknox delete participant parameters

Declaration

Swift

@objc(VSSKeyknoxDeleteParticipantParams)
public class KeyknoxDeleteRecipientParams : NSObject


                    
                    
                    KeyknoxResetParams

Keyknox reset parameters

Declaration

Swift

@objc(VSSKeyknoxResetParams)
public class KeyknoxResetParams : NSObject


                    
                    
                    KeyknoxPullParams

Keyknox pull parameters

Declaration

Swift

@objc(VSSKeyknoxPullParams)
public class KeyknoxPullParams : NSObject


                    
                    
                    KeyknoxPushParams

Keyknox push parameters

Declaration

Swift

@objc(VSSKeyknoxPushParams)
public class KeyknoxPushParams : NSObject


                    
                    
                    KeyknoxValue

Value stored on Keyknox service

Declaration

Swift

@objc(VSSKeyknoxValue)
public class KeyknoxValue : NSObject


                    
                    
                    EncryptedKeyknoxValue

Represent encrypted Keyknox value

Declaration

Swift

@objc(VSSEncryptedKeyknoxValue)
public class EncryptedKeyknoxValue : KeyknoxValue


                    
                    
                    DecryptedKeyknoxValue

Represent decrypted Keyknox value

Declaration

Swift

@objc(VSSDecryptedKeyknoxValue)
public class DecryptedKeyknoxValue : KeyknoxValue


                    
                    
                    CloudEntry

Class representing entry in cloud

Declaration

Swift

@objc(VSSCloudEntry)
public final class CloudEntry : NSObject, Codable


                    
                    
                    CloudKeyStorage

Class responsible for storing Keys in Cloud using E2EE

Declaration

Swift

@objc(VSSCloudKeyStorage)
open class CloudKeyStorage : NSObject

extension CloudKeyStorage: CloudKeyStorageProtocol


                    
                    
                    KeyknoxKeyEntry

Class representing Key entry: name + data + meta

Declaration

Swift

@objc(VSSKeyknoxKeyEntry)
public final class KeyknoxKeyEntry : NSObject


                    
                    
                    KeyknoxCrypto

KeyknoxCryptoProtocol implementation using VirgilCrypto

Declaration

Swift

open class KeyknoxCrypto

extension KeyknoxCrypto: KeyknoxCryptoProtocol


                    
                    
                    KeyknoxManager

Class responsible for managing Keyknox value with E2EE

Declaration

Swift

@objc(VSSKeyknoxManager)
open class KeyknoxManager : NSObject


                    
                    
                    SyncKeyStorage

Class responsible for synchronization between Keychain and Keyknox Cloud

Declaration

Swift

@objc(VSSSyncKeyStorage)
open class SyncKeyStorage : NSObject


                    
                    
                    SQLiteDB

SQLiteDB

Declaration

Swift

public class SQLiteDB : NSObject


                    
                    
                    SQLiteError

Represents error of SQLite

Declaration

Swift

@objc(VSSSQLiteError)
public class SQLiteError : NSObject, LocalizedError


                    
                    
                    Statement

SQLite statement

Declaration

Swift

public class Statement


                    
                    
                    FileSystemCredentials

Encryption credentials

Declaration

Swift

@objc(VSSFileSystemCredentials)
open class FileSystemCredentials : NSObject


                    
                    
                    FileSystem

Class for saving data to the filesystem

Note

This class is NOT thread-safe

Tag: FileSystem

Declaration

Swift

@objc(VSSFileSystem)
open class FileSystem : NSObject


                    
                    
                    Mutex

Mutex

Declaration

Swift

@objc(VSSMutex)
open class Mutex : NSObject


                    
                    
                    AsyncOperation

Class for AsyncOperations

Declaration

Swift

open class AsyncOperation : Operation


                    
                    
                    CallbackOperation

Async GenericOperation that can be initialized with callback

Declaration

Swift

open class CallbackOperation<T> : GenericOperation<T>


                    
                    
                    GenericOperation

Represents AsyncOperation with Generic result

Declaration

Swift

open class GenericOperation<T> : AsyncOperation