Skip to main content

Start a visit

To start or view a session, call the function

- (void)openVisitId:(NSString *_Nonnull)visitId
     withCustomerId:(NSString *_Nonnull)customerId
         withFilter:(NSString *_Nullable)filter
       withReadonly:(BOOL)readonly;

Request parameters

visitId string

Required. Visit ID.

customerId string

Required. ID of the point where you want to perform the visit.

filter string

Task filter (optional). Regular expression to filter tasks by name. If a filter is set, the visit will display only tasks that meet the specified filter.

readonly boolean

The visit is read-only. Tasks are viewable only. Optional.

Return from the Inspector Cloud app

After the user clicks «Return», control from the Inspector Cloud app will be transferred back to the calling application. To process this event, define a function:

- (BOOL)application:(UIApplication *)app
            openURL:(NSURL *)url
            options:(NSDictionary<UIApplicationOpenURLOptionsKey, id> *)options {
    return [[ICDeepLink shared] proceedDeeplink:url];
}

To get information about a visit from the Inspector Cloud app, subscribe to delegate ICDeepLinkDelegate.

[ICDeepLink shared].delegate = self;

In this case, the method

- (void)reciveVisitId:(NSString *_Nonnull)visitId 
           customerId:(NSString *_Nonnull)customerId 
             userInfo:(NSDictionary * _Nonnull)userInfo;

will be called when passing control to the calling application.

Additional data is coming in the dictionary userInfo. The keys are available in the current version:

  • total_images - full number of photos in the visit.

In future versions of the SDK, the set of keys in userInfo can be expanded.

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