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

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

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

object DeepLinkConst {

    const val IC_CAMERA_LAUNCH_ACTION = "inspector.cloud.camera.DeepLinkActivity"

    object Parameters {
        const val TOKEN = "token"
        const val AGENT_ID = "agent_id"
        const val VISIT_ID = "visit_id"
        const val CUSTOMER_ID = "customer_id"
        const val LIST_CUSTOMER_ID = "list_customer_id"
        const val STRING_CUSTOMER_ID = "string_customer_id"
        const val TASK_FILTER = "task_filter"
        const val READONLY = "readonly"       
        const val TOTAL_IMAGES = "total_images"
        const val DEBUG = "debug"
        const val RESULT_CODE = "res_code"
        const val RESULT_INFO = "res_info"
        const val IC_COMMAND = "ic_command"      
    }

    object ResultCode {
        const val VISIT_VALID = 1
        const val VISIT_ERR = 2

        const val SYNC_OK = 3
        const val SYNC_ERR = 4
    }

    object Commands {
        const val IC_SYNC = "sync"
        const val IC_OPEN_LAST_VISIT = "open_last_visit"
    }
}

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

DeepLinkConst

---

DeepLinkConst.IC_CAMERA_LAUNCH_ACTION(String): Action для запуска IC Camera 3.

---

Parameters

DeepLinkConst.Parameters.TOKEN (String): Токен вызывающего приложения.

DeepLinkConst.Parameters.AGENT_ID (String): Идентификатор агента.

DeepLinkConst.Parameters.VISIT_ID (String): Идентификатор визита в системе.

DeepLinkConst.Parameters.CUSTOMER_ID (String): Идентификатор магазина.

DeepLinkConst.Parameters.LIST_CUSTOMER_ID (Array<String>): Массив строк с CUSTOMER_ID кодами магазинов для синхронизации.

DeepLinkConst.Parameters.STRING_CUSTOMER_ID (String): Альтернативный вариант списка магазинов. Строка с CUSTOMER_ID кодами, разделенными запятой (,) без пробелов.

DeepLinkConst.Parameters.TASK_FILTER (String): Регулярное выражение для фильтрации задач по названию.

DeepLinkConst.Parameters.READONLY (Boolean): Задает режим открытия визита только для чтения.

DeepLinkConst.Parameters.TOTAL_IMAGES (Long): Количество изображений в визите.

DeepLinkConst.Parameters.DEBUG (Boolean): Включение отладочного режима.

DeepLinkConst.Parameters.RESULT_CODE (Int): Код результата операции (см. раздел ResultCode).

DeepLinkConst.Parameters.RESULT_INFO (String): Описание ошибки или дополнительная информация.

DeepLinkConst.Parameters.IC_COMMAND (String): Управляющая команда (см. раздел Commands).

---

ResultCode

DeepLinkConst.ResultCode.VISIT_VALID (1): Успешный визит (новый или открытый). Завершен корректно.

DeepLinkConst.ResultCode.VISIT_ERR (2): Ошибка визита. Подробности в RESULT_INFO.

DeepLinkConst.ResultCode.SYNC_OK (3): Синхронизация успешно выполнена.

DeepLinkConst.ResultCode.SYNC_ERR (4): Синхронизация не выполнена. Подробности в RESULT_INFO.

---

Commands

DeepLinkConst.Commands.IC_SYNC ("sync"): Выполнить синхронизацию.

DeepLinkConst.Commands.IC_OPEN_LAST_VISIT ("open_last_visit"): Открыть последний визит в указанном магазине.

---

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