core/co.seam.core.api/SeamCredential

SeamCredential

data class SeamCredential(val id: String?, val supportedUnlockProximities: List<UnlockProximity>, val name: String, val location: String?, val expiry: LocalDateTime?, val cardNumber: String?, val code: String?, val errors: List<SeamCredentialError>, val isManaged: Boolean = true, val providerName: String)

A Seam credential object. It contains information about a credential, such as its ID, name, location, expiration date, and any errors that it encountered.

Constructors

SeamCredential

constructor(id: String?, supportedUnlockProximities: List<UnlockProximity>, name: String, location: String?, expiry: LocalDateTime?, cardNumber: String?, code: String?, errors: List<SeamCredentialError>, isManaged: Boolean = true, providerName: String)

Properties

cardNumber

val cardNumber: String?

The card number associated with the credential.

code

val code: String?

The code associated with the credential.

errors

val errors: List<SeamCredentialError>

A list of errors that the credential encountered.

expiry

val expiry: LocalDateTime?

The date and time when the credential expires.

val id: String?

The ID of the credential.

isManaged

val isManaged: Boolean = true

Indicates whether this credential was created and managed by the Seam API (true), or was discovered directly through the provider integration (false).

location

val location: String?

A human-readable location for the credential.

name

val name: String

A human-readable name for the credential.

providerName

val providerName: String

The provider name as String. Possible values: "hid_origo_credential_service" "salto_ks" "brivo" "assa_abloy_credential_service" "visionline_system" "latch" "assa_abloy_vostio" "assa_abloy_vostio_credential_service" "salto_space"

supportedUnlockProximities

val supportedUnlockProximities: List<UnlockProximity>

The list of unlock proximities supported by the credential. Possible values in the list: UnlockProximity.TOUCH UnlockProximity.NEARBY UnlockProximity.REMOTE