View on GitHub
Install in Dash
AvailabilityService Protocol Reference
AvailabilityService
public protocol AvailabilityServiceBase Protocol to create, setup, cancel Virtual Visits
-
Search for available providers
- departmentIds: An array of department Identifiers to filter availability on
- options: An optional list of
ProviderAvailabilityOptionsto filter on - success: A closure called with a
ProviderAvailabilityResultsobject - failure: A closure called if any FailedReason errors are returned
Declaration
Swift
func getProviderAvailability(departmentIds: [String], options: ProviderAvailabilityOptions?, success: @escaping (ProviderAvailabilityResult) -> Void, failure: @escaping (FailedReason) -> Void) -
getProviderAvailability(departmentIds:Asynchronousoptions: ) Search for available providers
- departmentIds: An array of department Identifiers to filter availability on
- options: An optional list of
ProviderAvailabilityOptionsto filter on
Throws
FailedReasonDeclaration
Swift
func getProviderAvailability(departmentIds: [String], options: ProviderAvailabilityOptions?) async throws -> ProviderAvailabilityResultReturn Value
ProviderAvailabilityResults -
Search for available providers
- latitude: Latitude of the location you would like to search
- longitude: Longitude of the location you would like to search
- radius: An optional radius around the location you would like to search in miles. Minimum is 1. Maximum is 100
- options: An optional list of
ProviderAvailabilityOptionsto filter on - success: A closure called with a
ProviderAvailabilityResultsobject - failure: A closure called if any FailedReason errors are returned
Declaration
Swift
func getProviderAvailability(latitude: Double, longitude: Double, radius: Int?, options: ProviderAvailabilityOptions?, success: @escaping (ProviderAvailabilityResult) -> Void, failure: @escaping (FailedReason) -> Void) -
Search for available providers
- latitude: Latitude of the location you would like to search
- longitude: Longitude of the location you would like to search
- radius: An optional radius around the location you would like to search in miles. Minimum is 1. Maximum is 100
- options: An optional list of
ProviderAvailabilityOptionsto filter on
Throws
FailedReasonDeclaration
Swift
func getProviderAvailability(latitude: Double, longitude: Double, radius: Int?, options: ProviderAvailabilityOptions?) async throws -> ProviderAvailabilityResultReturn Value
ProviderAvailabilityResults -
Search for available providers
- zipCode: 5 digit zip code of the location you’d like to search
- radius: An optional radius around the location you would like to search in miles. Minimum is 1. Maximum is 100
- options: An optional list of
ProviderAvailabilityOptionsto filter on - success: A closure called with a
ProviderAvailabilityResultsobject - failure: A closure called if any FailedReason errors are returned
Declaration
Swift
func getProviderAvailability(zipCode: String, radius: Int?, options: ProviderAvailabilityOptions?, success: @escaping (ProviderAvailabilityResult) -> Void, failure: @escaping (FailedReason) -> Void) -
getProviderAvailability(zipCode:Asynchronousradius: options: ) Search for available providers
- zipCode: 5 digit zip code of the location you’d like to search
- radius: An optional radius around the location you would like to search in miles. Minimum is 1. Maximum is 100
- options: An optional list of
ProviderAvailabilityOptionsto filter on
Throws
FailedReasonDeclaration
Swift
func getProviderAvailability(zipCode: String, radius: Int?, options: ProviderAvailabilityOptions?) async throws -> ProviderAvailabilityResultReturn Value
ProviderAvailabilityResults
-
getProviderAvailabilitySlots(departmentIds:Asynchronousoptions: ) Search for provider aggregated time slots
- departmentIds: An array of department Identifiers to filter availability slots on
- options: An list of
ProviderAvailabilityOptionsto filter on. Note:ProviderAvailabilityOptions.visitTypeNamesis required.
Throws
FailedReasonDeclaration
Swift
func getProviderAvailabilitySlots(departmentIds: [String], options: ProviderAvailabilityOptions) async throws -> ProviderSlotAvailabilityReturn Value
-
Search for provider aggregated time slots
- departmentIds: An array of department Identifiers to filter availability slots on
- options: An list of
ProviderAvailabilityOptionsto filter on. Note:ProviderAvailabilityOptions.visitTypeNamesis required. - success: A closure called with a
ProviderSlotAvailabilityobject - failure: A closure called if any FailedReason errors are returned
Declaration
Swift
func getProviderAvailabilitySlots(departmentIds: [String], options: ProviderAvailabilityOptions, success: @escaping (ProviderSlotAvailability) -> Void, failure: @escaping (FailedReason) -> Void) -
Search for provider aggregated time slots
- zipCode: 5 digit zip code of the location you’d like to search
- radius: An optional radius around the location you would like to search in miles. Minimum is 1. Maximum is 100
- options: An list of
ProviderAvailabilityOptionsto filter on. Note:ProviderAvailabilityOptions.visitTypeNamesis required.
Throws
FailedReasonDeclaration
Swift
func getProviderAvailabilitySlots(zipCode: String, radius: Int?, options: ProviderAvailabilityOptions) async throws -> ProviderSlotAvailabilityReturn Value
-
Search for provider aggregated time slots
- zipCode: 5 digit zip code of the location you’d like to search
- radius: An optional radius around the location you would like to search in miles. Minimum is 1. Maximum is 100
- options: An list of
ProviderAvailabilityOptionsto filter on. Note:ProviderAvailabilityOptions.visitTypeNamesis required. - success: A closure called with a
ProviderSlotAvailabilityobject - failure: A closure called if any FailedReason errors are returned
Declaration
Swift
func getProviderAvailabilitySlots(zipCode: String, radius: Int?, options: ProviderAvailabilityOptions, success: @escaping (ProviderSlotAvailability) -> Void, failure: @escaping (FailedReason) -> Void) -
Search for provider aggregated time slots
- latitude: Latitude of the location you would like to search
- longitude: Longitude of the location you would like to search
- radius: An optional radius around the location you would like to search in miles. Minimum is 1. Maximum is 100
- options: An list of
ProviderAvailabilityOptionsto filter on. Note:ProviderAvailabilityOptions.visitTypeNamesis required.
Throws
FailedReasonDeclaration
Swift
func getProviderAvailabilitySlots(latitude: Double, longitude: Double, radius: Int?, options: ProviderAvailabilityOptions) async throws -> ProviderSlotAvailabilityReturn Value
-
Search for provider aggregated time slots
- latitude: Latitude of the location you would like to search
- longitude: Longitude of the location you would like to search
- radius: An optional radius around the location you would like to search in miles. Minimum is 1. Maximum is 100
- options: An list of
ProviderAvailabilityOptionsto filter on. Note:ProviderAvailabilityOptions.visitTypeNamesis required. - success: A closure called with a
ProviderSlotAvailabilityobject - failure: A closure called if any FailedReason errors are returned
Declaration
Swift
func getProviderAvailabilitySlots(latitude: Double, longitude: Double, radius: Int?, options: ProviderAvailabilityOptions, success: @escaping (ProviderSlotAvailability) -> Void, failure: @escaping (FailedReason) -> Void)