Cely Credentials#

set(_:) -> Result#

Securely store user credentials.

Declaration

public func set(
  username: String,
  password: String,
  server: String,
  controlOptions: [AccessControlOptions]
) -> Result<Void, Error>

Example

// Example
let credentialResult = Cely.credentials.set(
    username: username,
    password: password,
    server: "api.example.com"
    controlOptions: [.biometricsIfPossible]
)

switch credentialResult {
case let .success:
    print("success!")
case let .failure(error):
    print("failed to store credentials")
}

Parameters

Parameter	Type	Required?	Description
username	String	✅	username for user.
password	String	✅	password for user.
server	String	✅	API uri for account.
controlOptions	[AccessControlOptions]	no	Array of AccessControlOptions for credentials to be saved with.

get() -> Result#

Retrieve the current user's credentials

Declaration

func get() -> Result<CelyCredentials, Error>

Example

let result = Cely.credentials.get()

switch result {
case let .success(credentials):
    print(credentials)
case let .failure(error):
    print("failed to get credentials")
}