Константы, которые используются в API

Здесь описан весь перечень констант, которые используются в Deeplink API Android.

Список параметров

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";
    }
}

Описание параметров

DeepLinkConst

DeepLinkConst.IC_CAMERA_LAUNCH_ACTION string

Intent запуска IC Camera на устройстве. Если установлены оба приложения, появится диалоговое окно с выбором версии IC Camera.

DeepLinkConst.IC_CAMERA_2_PACKAGE, DeepLinkConst.IC_CAMERA_2_ACTIVITY string

Компоненты для запуска приложения IC Camera 2.

DeepLinkConst.IC_CAMERA_3_PACKAGE, DeepLinkConst.IC_CAMERA_3_ACTIVITY string

Компоненты для запуска приложения IC Camera 3.

Parameters

DeepLinkConst.Parameters.TOKEN string

Токен вызывающего приложения.

DeepLinkConst.Parameters.AGENT_ID string

Идентификатор агента в формате UUID.

DeepLinkConst.Parameters.VISIT_ID string

Идентификатор визита в системе.

DeepLinkConst.Parameters.CUSTOMER_ID string

Идентификатор магазина. По CUSTOMER_ID выполняется поиск магазина (store -> customer_id).

DeepLinkConst.Parameters.LIST_CUSTOMER_ID string[]

Массив строк с CUSTOMER_ID кодами магазинов для синхронизации данных по этим магазинам.

DeepLinkConst.Parameters.STRING_CUSTOMER_ID array

Альтернативный вариант списка с CUSTOMER_ID кодами магазинов для синхронизации данных по этим магазинам.

В данном формате передается строка с CUSTOMER_ID кодами, которые разделены запятой («,») без пробелов. Если в команде заданы оба способа, то будут использованы значения из STRING_CUSTOMER_ID.

DeepLinkConst.Parameters.TASK_FILTER string

Фильтр задач. Регулярное выражение (описание) для фильтрации задач по названию. Если указан, то визит будет отображать задачи, которые удовлетворяют заданному фильтру.

DeepLinkConst.Parameters.READONLY boolean

Задает режим открытия визита только для чтения. В этом режиме задачи доступны только для просмотра.

DeepLinkConst.Parameters.TOTAL_IMAGES integer

Количество изображений в визите.

DeepLinkConst.Parameters.DEBUG boolean

Включение отладочного режима. Отображает лог с выводом основных ошибок и вызывающих параметров.

DeepLinkConst.Parameters.VERSION_API integer

Версия встроенного API в приложение.

DeepLinkConst.Parameters.VERSION_APP integer

Код версии приложения.

DeepLinkConst.Parameters.IS_NEW_VISIT boolean

Флаг, обозначающий новый созданный визит.

ResultCode

DeepLinkConst.Parameters.RESULT_CODE integer

Код результата.

VISIT_VALID (int: 1) - успешный визит (новый или открытый). Завершен с помощью кнопки закрытия визита.
VISIT_ERR (int: 2) - ошибка визита. Подробная информация в RESULT_INFO.
SYNC_OK (int: 3) - cинхронизация успешно выполнена.
SYNC_ERR (int: 4) - синхронизация не выполнена. Подробная информация в RESULT_INFO.

DeepLinkConst.Parameters.RESULT_INFO string

Описание ошибки или дополнительная информация.

Commands

DeepLinkConst.Parameters.IC_COMMAND string

Управляющая команда. Поддерживаемые команды:

IC_SYNC — выполнить синхронизацию;
IC_OPEN_LAST_VISIT — открыть последний визит в указанном магазине.

Если у вас возникли вопросы или проблемы, обратитесь в техподдержку.

Список параметров​

Описание параметров​

DeepLinkConst​

Parameters​

ResultCode​