API reference and developer documentation
From LIVECHAT Developer Zone Wiki
Contents |
API Reference
The LIVECHAT API is an application programming interface with a set of services and data structures to extend the core functionality of LIVECHAT Software products. The API documentation is a reference documentation. The following topics provide information about the programming elements included in the LIVECHAT API.
The purpose of this document is to present the API reference and guide developers how to work with the API and create new add-ons for:
This reference contains the technical and conceptual information in the area of:
- API Terminology
- Data types
- Properties
- Services
- Hooks
- Error codes
Data types
The data types supported by LIVECHAT API are used to define function parameters and structure members.
- Enumerated data types:
- Data structures:
- User interface structures:
- LCTOOLBAR (deprecated)
- LCTOOLBARITEM
- LCSTATUSBARITEM
- LCPANEL
- LCMENUITEM
- LCBARPANE (deprecated)
- LCINFOBAR
- LCMSGBOX
- LCPREFERENCESITEM
- LCPREFERENCESPAGE
- LCWEBPANEL
Properties
- PROP_LANGUAGE
- PROP_LOCAL_ADDRESS
- PROP_REMOTE_ADDRESS
- PROP_SYSTEM_ADDRESS
- PROP_SYSTEM_PORT
- PROP_DESKTOPSHARE_PORT
- PROP_USER_ID
- PROP_CUSTOM_URL
- PROP_VIDEO_URL
- PROP_SERVER_ADDRESS
Services
- SVC_CREATE_TOOLBAR (deprecated)
- SVC_ADD_TOOLBARITEM
- SVC_ADD_CHATBARITEM
- SVC_ADD_PANEL
- SVC_ADD_MENUITEM
- SVC_ADD_STATUSBARITEM
- SVC_ADD_BARPANE (deprecated)
- SVC_CREATE_INFOBAR
- SVC_MESSAGEBOX
- SVC_ADD_WEB_PANEL
- SVC_NAVIGATE_PANEL
- SVC_GET_PANEL_URL
- SVC_SHOW_PREFERENCES_PAGE
- SVC_ADD_PREFERENCES_CONTROL
- SVC_ADD_PREFERENCES_PAGE
- SVC_SHOW_PLUGIN_PREFERENCES_PAGE
- SVC_SET_PREFERENCES_VALUE
- SVC_GET_PREFERENCES_VALUE
- SVC_REMOVE_PREFERENCES_VALUE
- SVC_SET_PROPERTY
- SVC_GET_PROPERTY
- SVC_SET_REGPROPERTY (deprecated)
- SVC_GET_REGPROPERTY (deprecated)
- SVC_GET_SESSION_PROP
- SVC_GET_SETTINGS_PROP
- SVC_ADD_PROTOCOL
- SVC_GET_PROTOCOL_ACCOUNT
- SVC_ADD_BUDDY
- SVC_NEW_MESSAGE
- SVC_SET_BUDDY_STATUS
- SVC_GET_BUDDYLIST
- SVC_SET_PROTOCOL_STATUS
- SVC_SET_STATUS
- SVC_GET_STATUS
- SVC_GET_PREVIOUS_STATUS
- SVC_MAKE_UUID
- SVC_DETAG
- SVC_LOG
- SVC_HAS_BUDDY
- SVC_HAS_VISITOR
- SVC_GET_BUDDY_PROP
- SVC_GET_BUDDY_DISPNAME
- SVC_ADD_PHONE
- SVC_SET_CALLBACK_STATUS
- SVC_PLAY_SOUND
- SVC_SEND_COMMAND
- SVC_SEND_MESSAGE
- SVC_GET_CHAT_PROTOCOL
- SVC_GET_CHAT_GROUP
- SVC_SHOW_IMPORT_DIALOG
- SVC_GET_CONTACT_ID
- SVC_GET_VISITOR_PARAM
