🇺🇸English
🇪🇸Español
🇧🇷Português

docs.api.title

docs.api.intro

docs.api.methodsTitle

docs.api.methoddocs.api.parametersdocs.api.returnsdocs.api.description
init(config)ChaskWidgetConfigPromise<void>docs.api.initDesc
open()-voiddocs.api.openDesc
close()-voiddocs.api.closeDesc
toggle()-voiddocs.api.toggleDesc
send(message)stringPromise<void>docs.api.sendDesc
setUser(user)UserConfigPromise<void>docs.api.setUserDesc
getState()-WidgetStatedocs.api.getStateDesc
showLauncher()-voiddocs.api.showLauncherDesc
hideLauncher()-voiddocs.api.hideLauncherDesc
destroy()-voiddocs.api.destroyDesc
isInitialized()-booleandocs.api.isInitializedDesc

Usage Examples

// Initialize the widget
await ChaskWidget.init({
  apiKey: 'your-api-key',
  organizationId: 'your-org-id'
});

// Open the chat window
ChaskWidget.open();

// Send a message programmatically
await ChaskWidget.send('Hello, I need help!');

// Update user information
await ChaskWidget.setUser({
  id: 'user-456',
  name: 'Jane Doe',
  email: 'jane@example.com'
});

// Get current state
const state = ChaskWidget.getState();
console.log('Unread messages:', state.unreadCount);

// Toggle chat visibility
ChaskWidget.toggle();

// Hide the launcher button
ChaskWidget.hideLauncher();

// Cleanup when done
ChaskWidget.destroy();

docs.api.stateTitle

docs.api.stateDesc

docs.api.propertydocs.configuration.typedocs.api.description
initializedbooleanWhether the widget is initialized
isOpenbooleanWhether the chat window is open
isConnectedbooleanWhether connected to WebSocket
unreadCountnumberCount of unread messages
errorWidgetError | nullCurrent error state

State Example

const state = ChaskWidget.getState();

if (state.isConnected) {
  console.log('Connected to chat server');
  console.log('Unread:', state.unreadCount);
}

if (state.error) {
  console.error('Widget error:', state.error.message);
}