@firebolt-js/manage-sdk/dist/lib/VoiceGuidance/index.mjs

The Firebolt Manage JS SDK

/*
 * Copyright 2021 Comcast Cable Communications Management, LLC
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 * SPDX-License-Identifier: Apache-2.0
 */

import Transport from '../Transport/index.mjs'
import Events from '../Events/index.mjs'
import { registerEvents } from '../Events/index.mjs'
import Prop from '../Prop/index.mjs'

registerEvents('VoiceGuidance', [
  'enabledChanged',
  'navigationHintsChanged',
  'rateChanged',
  'speedChanged',
])

Transport.registerDeprecatedMethod(
  'VoiceGuidance',
  'speed',
  'Use VoiceGuidance.rate() instead.',
)
Transport.registerDeprecatedMethod(
  'VoiceGuidance',
  'onSpeedChanged',
  'Use speed instead.',
)
Transport.registerDeprecatedMethod(
  'VoiceGuidance',
  'setSpeed',
  'Use VoiceGuidance.rate() instead.',
)

// onEnabledChanged is accessed via listen('enabledChanged, ...)

// onNavigationHintsChanged is accessed via listen('navigationHintsChanged, ...)

// onRateChanged is accessed via listen('rateChanged, ...)

// onSpeedChanged is accessed via listen('speedChanged, ...)

// Methods
function clear(...args) {
  return Events.clear('VoiceGuidance', ...args)
}

function enabled() {
  let callbackOrValue = arguments[0]
  let params = {}

  // x-subscriber-type: global
  if (arguments.length === 1 && typeof arguments[0] === 'function') {
    callbackOrValue = arguments[0]
    params = {}
  }

  return Prop.prop(
    'VoiceGuidance',
    'enabled',
    params,
    callbackOrValue,
    false,
    false,
    0,
  )
}
function listen(...args) {
  return Events.listen('VoiceGuidance', ...args)
}

function navigationHints() {
  let callbackOrValue = arguments[0]
  let params = {}

  // x-subscriber-type: global
  if (arguments.length === 1 && typeof arguments[0] === 'function') {
    callbackOrValue = arguments[0]
    params = {}
  }

  return Prop.prop(
    'VoiceGuidance',
    'navigationHints',
    params,
    callbackOrValue,
    false,
    false,
    0,
  )
}
function once(...args) {
  return Events.once('VoiceGuidance', ...args)
}

function rate() {
  let callbackOrValue = arguments[0]
  let params = {}

  // x-subscriber-type: global
  if (arguments.length === 1 && typeof arguments[0] === 'function') {
    callbackOrValue = arguments[0]
    params = {}
  }

  return Prop.prop(
    'VoiceGuidance',
    'rate',
    params,
    callbackOrValue,
    false,
    false,
    0,
  )
}
function speed() {
  let callbackOrValue = arguments[0]
  let params = {}

  // x-subscriber-type: global
  if (arguments.length === 1 && typeof arguments[0] === 'function') {
    callbackOrValue = arguments[0]
    params = {}
  }

  return Prop.prop(
    'VoiceGuidance',
    'speed',
    params,
    callbackOrValue,
    false,
    false,
    0,
  )
}

export default {
  Events: {
    ENABLED_CHANGED: 'enabledChanged',
    NAVIGATION_HINTS_CHANGED: 'navigationHintsChanged',
    RATE_CHANGED: 'rateChanged',
    SPEED_CHANGED: 'speedChanged',
  },

  clear,
  enabled,
  listen,
  navigationHints,
  once,
  rate,
  speed,
}