Skip to main content

Constants used in the API

The entire list of constants that are used in the Android Deeplink API is described here.

Parameter List

public class DeepLinkConst {

    public static final String IC_CAMERA_LAUNCH_ACTION = "inspector.cloud.camera.DeepLinkActivity";
    public static final String IC_CAMERA_2_PACKAGE = "inspector.cloud.camera";
    public static final String IC_CAMERA_2_ACTIVITY = "inspector.cloud.camera.DeepLinkActivity";
    public static final String IC_CAMERA_3_PACKAGE = "com.iccamera3.app";
    public static final String IC_CAMERA_3_ACTIVITY = "com.iccamera3.app.MainActivity";

    public static final class Parameters {
        public static final String TOKEN = "token";
        public static final String AGENT_ID = "agent_id";
        public static final String VISIT_ID = "visit_id";
        public static final String CUSTOMER_ID = "customer_id";
        public static final String LIST_CUSTOMER_ID = "list_customer_id";
        public static final String STRING_CUSTOMER_ID = "string_customer_id";
        public static final String TASK_FILTER = "task_filter";
        public static final String READONLY = "readonly";       
        public static final String TOTAL_IMAGES = "total_images";
        public static final String DEBUG = "debug";
        public static final String VERSION_API = "version_api";
        public static final String VERSION_APP = "version_app";
        public static final String IS_NEW_VISIT = "is_new_visit";
        public static final String RESULT_CODE = "res_code";
        public static final String RESULT_INFO = "res_info";
        public static final String IC_COMMAND = "ic_command";      
        
    }


    public static final class ResultCode {
        public static final int VISIT_VALID = 1;
        public static final int VISIT_ERR = 2;

        public static final int SYNC_OK = 3;
        public static final int SYNC_ERR = 4;
    }

    public static final class Commands {
        public static final String IC_SYNC = "sync";
        public static final String IC_OPEN_LAST_VISIT = "open_last_visit";
    }
}

Description

DeepLinkConst

DeepLinkConst.IC_CAMERA_LAUNCH_ACTION string

Intent launch IC Camera on the device. If both applications are installed, a dialog box will appear asking you to select the version of IC Camera.

DeepLinkConst.IC_CAMERA_2_PACKAGE, DeepLinkConst.IC_CAMERA_2_ACTIVITY string

Components to run the IC Camera 2 application.

DeepLinkConst.IC_CAMERA_3_PACKAGE, DeepLinkConst.IC_CAMERA_3_ACTIVITY string

Components to run the IC Camera 3 application.

Parameters

DeepLinkConst.Parameters.TOKEN string

Token of the calling application.

DeepLinkConst.Parameters.AGENT_ID string

Agent ID in UUID format.

DeepLinkConst.Parameters.VISIT_ID string

The ID of the visit in the system.

DeepLinkConst.Parameters.CUSTOMER_ID string

Store ID. By CUSTOMER_ID a store is searched (store -> customer_id).

DeepLinkConst.Parameters.LIST_CUSTOMER_ID string[]

An array of strings with CUSTOMER_ID store codes to synchronize data on these stores.

DeepLinkConst.Parameters.STRING_CUSTOMER_ID array

Alternative version of the list with CUSTOMER_ID codes of stores to synchronize data on these stores.

In this format, a string with CUSTOMER_ID codes is passed, which are separated by a comma (",") without spaces. If both methods are specified in the command, then the values ​​from STRING_CUSTOMER_ID will be used.

DeepLinkConst.Parameters.TASK_FILTER string

Task filter. Regular expression (description) for filtering tasks by name. If specified, the visit will display tasks that match the specified filter.

DeepLinkConst.Parameters.READONLY boolean

Specifies the read-only session opening mode. In this mode, tasks are view-only.

DeepLinkConst.Parameters.TOTAL_IMAGES integer

The number of images in the visit.

DeepLinkConst.Parameters.DEBUG boolean

Enable debug mode. Displays a log with the output of the main errors and calling parameters.

DeepLinkConst.Parameters.VERSION_API integer

The version of the built-in API in the app.

DeepLinkConst.Parameters.VERSION_APP integer

Application version code.

DeepLinkConst.Parameters.IS_NEW_VISIT boolean

A flag indicating a newly created visit.

ResultCode

DeepLinkConst.Parameters.RESULT_CODE integer

Result code.

  • VISIT_VALID (int: 1) - successful visit (new or opened). Completed with the button to close the visit.
  • VISIT_ERR (int: 2) - visit error. See RESULT_INFO for details.
  • SYNC_OK (int: 3) - synchronization was successful.
  • SYNC_ERR (int: 4) - synchronization failed. See RESULT_INFO for details.

DeepLinkConst.Parameters.RESULT_INFO string

Description of the error or additional information.

Commands

DeepLinkConst.Parameters.IC_COMMAND string

Control command. Supported commands:

If you have any questions or problems, contact support.