Skip to main content

Start a visit

To start a new visit or view an existing one, call the following function:

ICDeepLinkService.shared.openVisit(visitId: "visitId",
                            customerId: "customerId",
                            isReadonly: false,
                            filter: "")

  • visitId - visit ID

  • customerId - ID of the location (store) where the visit will be performed

  • filter - (optional) task filter, used to display only those tasks that match the specified regular expression (description). If no filter is specified, all tasks will be displayed.

  • readonly - flag that determines whether the visit will be opened in read-only mode. In read-only mode, tasks are only available for viewing.

After completing a visit, the IC Camera app automatically returns to the app from which the visit was started. To handle incoming links, use the following method in the SceneDelegate class:

func scene(_ scene: UIScene, openURLContexts URLContexts: Set<UIOpenURLContext>) {
    for context in URLContexts {
        ICDeepLinkService.shared.proceedDeeplink(url: context.url)
    }
}

Subscribing to a delegate

To receive information about a completed visit and the store where it was performed, subscribe to the ICDeepLinkDelegate delegate.

ICDeepLinkService.shared.delegate = self

The delegate method will be called upon return to your application:

func receive(customerId: String, totalImages: Int)

  • customerId — ID of the point where the visit occurred.

  • totalImages — Total number of images taken during the visit.

This documentation will help you quickly set up and use the ICDeepLink library for integration with the IC Camera app.

If you have any questions or problems, contact technical support.