Documentation

Listening for Events

You can listen for events by running the following code:

upscopeManager.on(event: .eventName) { data in
    // Handle event
}

List of Events

Event NameAdditional ArgumentsDescription
beginSessionA session has started.
continueSessionA session is continuing from a previous app launch.
endSessionA session has ended.
stopSessionThe session was stopped by the visitor.
newObserverobserverId: String, observer: { id: String, name: String?, screenWidth: Int, screenHeight: Int, windowWidth: Int, windowHeight: Int, hasFocus: Bool }Indicates a new agent is observing.
observerUpdateobserverId: String, data: [String: String]An observer's data has changed.
observerGoneobserverId: StringobserverId is no longer observing.
observerContentVisibleobserverId: StringobserverId can now see the content (it is no longer loading).
observersCountcount: IntProvides an accurate tally of the number of people currently observing.
customMessagemessage: StringA custom message sent by an observer or visitor.
callStartcallId: StringAn audio call has started.
callAcceptedAn audio call has been accepted by the visitor.
callEndAn audio call has ended.