Hierarchy

  • ApiClient

Constructors

Methods

  • Activates usage of custom IDs for a given configurator. This only needs to be executed once per configurator.

    Afterwards, new custom IDs can be generated using generateCustomId.

    Parameters

    • companyName: string
    • configuratorName: string
    • startValue: string
    • warningThreshold: string
    • Optional callback: ((request: any, success: boolean, response: any) => void)
        • (request: any, success: boolean, response: any): void
        • Parameters

          • request: any
          • success: boolean
          • response: any

          Returns void

    Returns void

  • Activates usage of custom IDs with "shuffled strings" for a given configurator. This only needs to be executed once per configurator.

    Afterwards, new custom IDs can be generated using generateCustomId.

    Example for a valid call:

    Cbn.ApiClient.Configurators.setupShuffledCustomId(
    "ADAMS", // companyName
    "MARIMBA", // configuratorName
    "1", // startValue
    "99999", // warningThreshold
    // bitSwapPattern: An arbitrary amount of numbers from 0 to 62 in random order
    [
    3, 1, 2, 0, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29,
    30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56,
    57, 58, 59, 60, 61, 62
    ]
    );

    Parameters

    • companyName: string
    • configuratorName: string
    • startValue: string
    • warningThreshold: string
    • bitSwapPattern: number[]

      Can hold an arbitrary amount of numbers from 0 to 62 in random order.

    • Optional callback: ((request: any, success: boolean, response: any) => void)
        • (request: any, success: boolean, response: any): void
        • Parameters

          • request: any
          • success: boolean
          • response: any

          Returns void

    Returns void

Generated using TypeDoc