Structures

The following structures are available globally.

  • A Vsign action can have params. This is the base class representing VSING params

    See more

    Declaration

    Swift

    public struct QPActionParams : Decodable

  • Undocumented

    See more

    Declaration

    Swift

    public struct QPBearing : Decodable

  • Undocumented

    See more

    Declaration

    Swift

    public struct QPCategoriesResponse : Decodable

  • Undocumented

    See more

    Declaration

    Swift

    public struct QPCategoryInfo : Codable

  • Undocumented

    See more

    Declaration

    Swift

    public struct QPCodableCircularRegion : Codable

  • Event triggered when the Engine receives the first GPS update, which is required to perform the initial operations

    See more

    Declaration

    Swift

    public struct QPEngineStarted : QPEvent

  • Event triggered when the Engine’s stopped.

    See more

    Declaration

    Swift

    public struct QPEngineStopped : QPEvent

  • Event triggered when the network status changes, e.g. from “connected” to “disconnected”

    See more

    Declaration

    Swift

    public struct QPConnectivityChangedEvent : QPEvent

  • Event triggered when the Engine receives a GPS update from the system module

    See more

    Declaration

    Swift

    public struct QPLocationUpdatedEvent : QPEvent

  • Event triggered when the Engine detects the user has entered a VSign.

    See more

    Declaration

    Swift

    public struct QPEnteredVSignEvent : QPEvent

  • Event triggered when a VSign has been notified to the user. Handle this event to show a system notification to the user.

    Example:

    “`let content = UNMutableNotificationContent() guard let message = event.signal.getMessage(…..) else { return }

    content.title = "Your notification’s title” content.body = message.text content.sound = UNNotificationSound.default

    let request = UNNotificationRequest(identifier: event.signal.id, content: content, trigger: nil) let notificationCenter = UNUserNotificationCenter.current() notificationCenter.add(request)“`

    See more

    Declaration

    Swift

    public struct QPNotifiedVSignEvent : QPEvent

  • Event triggered when the Engine fetches the list of vSigns from the API

    See more

    Declaration

    Swift

    public struct QPVSignsFetchedEvent : QPEvent

  • Event triggered when the Engine detects that the user has exited the circular region coveder by the latest API call to fetch the relative vSigns.

    See more

    Declaration

    Swift

    public struct QPExitedApiCoverageRegionEvent : QPEvent

  • Event triggered when the vSign notified status has been reset.

    See more

    Declaration

    Swift

    public struct QPResetVSignStatus : QPEvent

  • Event triggered when iOS notified the Engine that GPS updates have been suspended because of inactivity.

    See more

    Declaration

    Swift

    public struct QPGPSUpdatesPaused : QPEvent

  • Event triggered when iOS notified the Engine that GPS updates have been suspended because of inactivity.

    See more

    Declaration

    Swift

    public struct QPUserActivityChangedEvent : QPEvent

  • Event triggered when the Engine is automatically restarted based on current activity detection logic (e.g. driving)

    See more

    Declaration

    Swift

    public struct QPEngineAutoActivated : QPEvent

  • Undocumented

    See more

    Declaration

    Swift

    public struct QPEngineAutoDeactivated : QPEvent

  • Undocumented

    See more

    Declaration

    Swift

    public struct QPEngineAutoDeactivatedLongTerm : QPEvent

  • Undocumented

    See more

    Declaration

    Swift

    public struct QPFCDServiceFinished : QPEvent

  • Struct that defines a permission.

    See more

    Declaration

    Swift

    public struct QPPermission

  • Undocumented

    See more

    Declaration

    Swift

    public struct QPPoint : Codable

  • Undocumented

    See more

    Declaration

    Swift

    public struct QPPsk : Codable

  • Undocumented

    See more

    Declaration

    Swift

    public struct QPReactivateTimeout : Decodable

  • A virtual sign action

    See more

    Declaration

    Swift

    public struct QPSignalAction : Decodable

  • Undocumented

    See more

    Declaration

    Swift

    public struct QPSignalAnticipate : Decodable

  • Data Model class representing a TTS message linked to a vSign.

    See more

    Declaration

    Swift

    public struct QPSignalMessage : Decodable

  • Undocumented

    See more

    Declaration

    Swift

    public struct QPSignalsResponse : Decodable

  • Welcome message should be read only one time and then not read for a while.

    See more

    Declaration

    Swift

    struct QPWelcomeMessage

  • Options for a welcome message

    See more

    Declaration

    Swift

    struct WelcomeMessageOptions : Decodable

  • Undocumented

    See more

    Declaration

    Swift

    struct QPSecureManager

  • Undocumented

    See more

    Declaration

    Swift

    public struct UserActivityDetectedMessage : Codable