/**
 *
 * Make an engines that is available (appears on the list returned by getAvailableEngines) active.
 * After this call, the engine will be added to the list of engines loaded in the IME daemon and the
 * input sent using sendKeys will be converted by the active engine. Note that this is a
 * platform-independent method of activating IME (the platform-specific way being using keyboard shortcuts.
 * (Not part of the official Webdriver specification)
 *
 * @param {String} engine   Name of the engine to activate.
 *
 * @see  https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#sessionsessionidimeactive_engine
 * @type protocol
 *
 */

import { ProtocolError } from '../utils/ErrorHandler'
import depcrecate from '../helpers/depcrecationWarning'

export default function imeActivate (engine) {
    if (typeof engine !== 'string') {
        throw new ProtocolError('number or type of arguments don\'t agree with imeActivate protocol command')
    }

    depcrecate('imeActivate')
    return this.requestHandler.create('/session/:sessionId/ime/activate', { engine })
}