Client

protocol Client

Describes how to interfact with the backend.

Types

Interacting with a Client


                      
                      
                      availableDays(forCountry:completion:)

Determines days that can be downloaded.

Declaration

Swift

func availableDays(
	forCountry country: String,
	completion: @escaping AvailableDaysCompletionHandler
)

Parameters

`country`	Country code
`completion`	completion callback which includes the list of available days


                      
                      
                      availableHours(day:country:completion:)

Determines hours that can be downloaded for a given day.

Declaration

Swift

func availableHours(
	day: String,
	country: String,
	completion: @escaping AvailableHoursCompletionHandler
)


                      
                      
                      fetchDay(_:forCountry:completion:)

Fetches the keys for a given day and country code

Declaration

Swift

func fetchDay(
	_ day: String,
	forCountry country: String,
	completion: @escaping DayCompletionHandler
)

Parameters

`day`	The day that the keys belong to
`country`	It should be country code, like DE stands for Germany
`completion`	Once the request is done, the completion is called.


                      
                      
                      fetchHour(_:day:country:completion:)

Fetches the keys for a given hour of a specific day.

Declaration

Swift

func fetchHour(
	_ hour: Int,
	day: String,
	country: String,
	completion: @escaping HourCompletionHandler
)

Getting the Configuration


                      
                      
                      getRegistrationToken(forKey:withType:isFake:completion:)

Gets the registration token

Declaration

Swift

func getRegistrationToken(
	forKey key: String,
	withType type: String,
	isFake: Bool,
	completion completeWith: @escaping RegistrationHandler
)


                      
                      
                      getTestResult(forDevice:isFake:completion:)

Undocumented

Declaration

Swift

func getTestResult(
	forDevice registrationToken: String,
	isFake: Bool,
	completion completeWith: @escaping TestResultHandler
)


                      
                      
                      getTANForExposureSubmit(forDevice:isFake:completion:)

Undocumented

Declaration

Swift

func getTANForExposureSubmit(
	forDevice registrationToken: String,
	isFake: Bool,
	completion completeWith: @escaping TANHandler
)

Submit keys


                      
                      
                      submit(payload:isFake:completion:)

Submits exposure keys to the backend. This makes the local information available to the world so that the risk of others can be calculated on their local devices.

Declaration

Swift

func submit(
	payload: CountrySubmissionPayload,
	isFake: Bool,
	completion: @escaping KeySubmissionResponse
)

Parameters

`payload`	A set of properties to provide during the submission process
`isFake`	flag to indicate a fake request
`completion`	the completion handler of the submission call

FetchHoursCompletionHandler


                      
                      
                      fetchDays(_:forCountry:completion:)

Extension method

Fetch the keys with the given days and country code

Declaration

Swift

func fetchDays(
		_ days: [String],
		forCountry country: String,
		completion completeWith: @escaping (DaysResult) -> Void
)


                      
                      
                      fetchDays(_:hours:of:country:completion:)

Extension method

Undocumented

Declaration

Swift

func fetchDays(
	_ days: [String],
	hours: [Int],
	of day: String,
	country: String,
	completion completeWith: @escaping DaysAndHoursCompletionHandler
)


                      
                      
                      fetchHours(_:day:country:completion:)

Extension method

Undocumented

Declaration

Swift

func fetchHours(
	_ hours: [Int],
	day: String,
	country: String,
	completion completeWith: @escaping FetchHoursCompletionHandler
)

DaysAndHoursCompletionHandler