ember-liveagent

ember-liveagent

Salesforce's live agent chat integration for Ember.js applications.

Compatibility

• Ember.js v4.4 or above
• Ember CLI v4.4 or above
• Node.js v14 or above

Installation

ember install ember-liveagent

Usage

1. You'll need to configure your liveagent chat.

// config/environment.js
module.exports = function (environment) {
  let ENV = {
    "ember-liveagent": {
      salesforceURL: "[SALESFORCE_URL]",
      communityURL: "[COMMUNITY_URL]",
      org: "[ORG]",
      snapinName: "[SNAPIN_NAME]",
      baseLiveAgentContentURL: "[BASE_LIVEAGENT_CONTENT_URL]",
      deploymentId: "[DEPLOYMENT_ID]",
      buttonId: "[BUTTON_ID]",
      baseLiveAgentURL: "[BASE_LIVEAGENT_URL]",
      eswLiveAgentDevName: "[ESW_LIVEAGENT_DEV_NAME]",
    },
  };

  return ENV;
};

See the service for how the parameters are passed into embedded_svc's init method.

2. You can then inject the liveagent service provided by this addon to call the boot method which accepts optional parameters.

// app/routes/application.js
import Route from "@ember/routing/route";
import { inject as service } from "@ember/service";

export default class ApplicationRoute extends Route {
  @service liveagent;

  afterModel() {
    this.liveagent.boot({
      displayHelpButton: true, // default value: false
      isOfflineSupportEnabled: true, // default value: false
      language: "cs", // default value: 'en'
      defaultMinimizedText: "Ask guru", // default value: 'Chat with an Expert'
      loadingText: "Just wait a second", // default value: 'Loading'
      prepopulatedPrechatFields: { Email: "[e-mail]" }, // default value: {}
      offlineSupportMinimizedText: "You can contact us", // default value: 'Contact Us'
    });
  }
}

Contributing

See the Contributing guide for details.

License

This project is licensed under the MIT License.