npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@livechat/moments-sdk

v1.10.0

Published

Moments SDK is the library to integrate web application used as moments with Chat Widget. It's not necessary to use Moments SDK inside moments web applications, but it provides more chat widget integration options - It allows you to send messages as a vis

Downloads

349

Readme

Moments SDK

Moments SDK is the library to integrate web application used as moments with Chat Widget. It's not necessary to use Moments SDK inside moments web applications, but it provides more chat widget integration options - It allows you to send messages as a visitor, set visitor attributes or close Moment.

Getting Started

To simply get started with creating your moments app add @livechat/moments-sdk as dependency to your project:

npm install @livechat/moments-sdk

and then import createMomentsSDK function which is exported as default from package.

import createMomentsSDK from '@livechat/moments-sdk'

API Reference

createMomentsSDK

Default method exported by the library. It's initializing connection with chat widget. You can pass additional properties:

  • title - Application title, will be placed on moments title bar
  • icon - URL to Application icon, will be placed on moments title bar
  • isFragile - Boolean value, when set to true widget will require additional confirmation from user in order to close the moment.
import createMomentsSDK from '@livechat/moments-sdk'
createMomentsSDK({ title: 'My App', icon: 'https://img.com/my-icon.png' }).then(
    momentsSDK => {
        // your code
    },
)

sendMessage

Sends a message as a visitor in currently active chat. Parameters:

  • text - Message text
momentsSDK.sendMessage({ text: 'Chosen date: 19.12.2009' })

sendSystemMessage

Sends a system message in the currently active chat. Parameteres:

  • text - Message text
  • recipients - Optional, defines those who can display the message: all (default) or agents
momentsSDK.sendSystemMessage({ text: 'Survey submitted', recipients: 'agents' })

setAttributes

Set customer's attributes. Parameters:

  • customProperties - Customer's additional data object
momentsSDK.setAttributes({ clientId: 'SJ3CJ6JVNMK42A', source: 'Organic' })

setExternalLink

Sets the external link for the fullscreen version of the app, which will be opened in the new tab. Parameters:

  • link - URL of the fullscreen version
momentsSDK.setExternalLink('https://livechat.com')

close

Close moments app. Parameters:

This method has no parameters.

momentsSDK.close()

setIsFragile

Set isFragile value. It can be provided in initalization and changed later with this function. Parameters:

  • value - Boolean
momentsSDK.setIsFragile(true)

updateCustomerData

Update customer's name or email. Parameters:

  • name - Customer's name
  • email - Customer's email
momentsSDK.updateCustomerData({
    name: 'John Doe',
    email: '[email protected]',
})

setTitle

Set title value. It can be provided in initalization and changed later with this function. Parameters:

  • value - String
momentsSDK.setTitle('New Title')

LauncherData

Data passed from the Chat Widget. It is available since the moment of SDK initialization. It consists of:

  • licenseId - ID of the license for which Moment has been initialized
  • chatId - ID of customer's chat (returns undefined if no chat)
  • groupId - ID of customer's group

Feedback

In case of any issues or feature requests send them on https://www.livechatinc.com/community