DexcareSDK

public class DexcareSDK

The main class to initialize to use the DexCare Mobile SDK.

  • An instance of the PatientService protocol

    Declaration

    Swift

    public var patientService: PatientService { get }
  • An instance of the AppointmentService protocol

    Declaration

    Swift

    public var appointmentService: AppointmentService { get }
  • An instance of the VirtualService protocol

    Declaration

    Swift

    public var virtualService: VirtualService { get }
  • An instance of the RetailService protocol

    Declaration

    Swift

    public var retailService: RetailService { get }
  • An instance of the PracticeService protocol

    Declaration

    Swift

    public var practiceService: PracticeService { get }
  • An instance of the ProviderService protocol

    Declaration

    Swift

    public var providerService: ProviderService { get }
  • An instance of the PaymentService protocol

    Declaration

    Swift

    public var paymentService: PaymentService { get }
  • An instance of the AvailabilityService protocol

    Declaration

    Swift

    public var availabilityService: AvailabilityService { get }
  • The object that acts as the refreshTokenDelegate of the DexcareSDK

    The refreshTokenDelegate must adopt the RefreshTokenDelegate protocol. The sdk maintains a weak reference to the refreshTokenDelegate object. The refreshTokenDelegate object is responsible for requesting a new OAuth2 Token from the client when a network call receives a 401.

    Note

    if the refreshTokenDelegate is not set the calls will simply pass down the 401 to the client.

    Declaration

    Swift

    public weak var refreshTokenDelegate: RefreshTokenDelegate? { get set }
  • A set of options used by the SDK for UI changes, integration setup, various config options.

    Declaration

    Swift

    public var customizationOptions: CustomizationOptions? { get set }
  • Undocumented

    Declaration

    Swift

    public init(configuration: DexcareConfiguration)
  • Sets the bearer token for the majority of subsequent calls to the dexcare platform.

    A valid 0Auth2 token is required for the majority of the SDK calls.

    Declaration

    Swift

    public func signIn(accessToken: String)

    Parameters

    accessToken

    an OAuth2 token used for all calls

  • Removes the bearer token for the calls.

    Removes any cached values A valid 0Auth2 token is required for the majority of the SDK calls.

    Declaration

    Swift

    public func signOut()
  • Gets the latest status of the DexCare services

    DexcareStatus can be used to block certain functions of your app if there is a major incident, or have warnings about possible issues. The DexcareSDK platform does not use this status for any blocking calls. Results are cached, and are updated when any incidents or scheduled maintenances are happening on the DexCare platform.

    Declaration

    Swift

    public func getDexcareStatus(success: @escaping (DexcareStatus) -> Void, failure: @escaping (FailedReason) -> Void)

    Parameters

    success

    a closure called with the DexcareStatus object representing the status of the DexCare platform

    failure

    a closure called when the call to get the status fails. If this happens, please contact us.

  • getDexcareStatus() Asynchronous

    Undocumented

    Declaration

    Swift

    public func getDexcareStatus() async throws -> DexcareStatus