Structures

The following structures are available globally.

Access Key Management

  • Encrypted Access Key information type to facilitate offline crypto

    See more

    Declaration

    Swift

    public struct EAKInfo: Codable

Key Generation

  • A data type holding the public and private keys as Base64URL encoded strings, used for encryption and signing operations. Only the publicKey is sent to the E3db service.

    See more

    Declaration

    Swift

    public struct KeyPair

  • Configuration for the E3DB Client

    See more

    Declaration

    Swift

    public struct Config: Codable

Offline Crypto Operations

  • Data type to hold encrypted data and related info

    See more

    Declaration

    Swift

    public struct EncryptedDocument: Codable, Signable

  • Data type to hold the verified, unencrypted data and related info

    See more

    Declaration

    Swift

    public struct DecryptedDocument

  • A wrapper object around a given data type and its cryptographic signature. Note that document remains unchanged

    See more

    Declaration

    Swift

    public struct SignedDocument<T: Signable>: Signable

  • Data type to specify filters for querying records

    See more

    Declaration

    Swift

    public struct QueryParams: Encodable

  • A structure to hold a response from a query operation

    See more

    Declaration

    Swift

    public struct QueryResponse

  • A wrapper to hold unencrypted values

    See more

    Declaration

    Swift

    public struct RecordData

  • A type to hold metadata information created by a client

    See more

    Declaration

    Swift

    public struct ClientMeta: Codable

  • A type to hold metadata information about a given record

    See more

    Declaration

    Swift

    public struct Meta: Decodable

  • A type that holds unencrypted values and associated metadata

    See more

    Declaration

    Swift

    public struct Record

  • A type that holds a public encryption key

    Declaration

    Swift

    public struct ClientKey: Codable

  • A type that holds a public signing key

    Declaration

    Swift

    public struct SigningKey: Codable

  • A type that contains the registration response info

    See more

    Declaration

    Swift

    public struct ClientCredentials: Decodable

  • Represents information about an encrypted file stored by E3DB.

    See more

    Declaration

    Swift

    public struct FileMeta: Codable

Sharing

  • A type to describe an existing policy for records written by the client to share with a given user

    See more

    Declaration

    Swift

    public struct OutgoingSharingPolicy: Decodable

  • A type to describe an existing policy for records written by others and shared with the client

    See more

    Declaration

    Swift

    public struct IncomingSharingPolicy: Decodable

  • A type to describe an existing policy for clients that are authorized to perform sharing and revoking operations

    See more

    Declaration

    Swift

    public struct AuthorizerPolicy: Decodable