Chatwee JavaScript API documentation

Overwrites any chat property configured in the Chatwee Client Panel customize form. Use this method if you want to display the chat with custom properties (for instance, if you want to show the chat differently on a given subpage of your website).

Sample code


  var chatId = "5817d4ba9da1fb0065000029";
  var chatweeManager = new ChatweeLib.ChatweeManager(chatId);
  chatweeManager.SetChatProperty("chatweeLayout", "embedded");
  chatweeManager.Run();

Parameters

Name	Description	Type	Mandatory	Remarks
propertyName	name of the property	string	yes	-
propertyValue	the new property value	mixed	yes	-

Available properties

Name	Description	Type	Notes
mainLabel	the chat name displayed in the top left corner of the chat window	string	-
desktopLayout	defines the layout for the desktop view	string	"compact" and "tabbed" values allowed
desktopDisplayMode	defines the display mode for the chat	string	"embedded" and "fixed" values allowed
fixedModeDefaultState	default fixed chat state	string	"minimized" and "maximized" values allowed
fixedModeDefaultPosition	default fixed chat window position	string	"left" and "right" values allowed, valid for chatweeLayout set to "fixed" only
fixedModeDefaultWidth	default window width for fixed mode	number	valid for chatweeLayout set to "fixed" only
fixedModeDefaultHeight	default window height for fixed mode	number	valid for chatweeLayout set to "fixed" only
fixedModeForceFullHeight	force chat to take full height of a browser window in the fixed mode	boolean	valid for chatweeLayout set to "fixed" only
embeddedModeContainerSelector	DOM selector for the embedded chat's parent	string	valid for chatweeLayout set to "embedded" only
embeddedModeSizing	sizing mode for the embedded chat	string	"auto" and "manual" values allowed, valid for chatweeLayout set to "embedded" only
embeddedModeStaticWidth	fixed window width for the embedded chat	number	valid for chatweeLayout set to "embedded" only, valid for chatweeEmbeddedSize set to "manual" only
embeddedModeStaticHeight	fixed window height for the embedded chat	number	valid for chatweeLayout set to "embedded" only, valid for chatweeEmbeddedSize set to "manual" only
mobileModeDefaultPosition	chat switch position on mobile devices	string	"left" and "right" values allowed, valid for mobileVersionEnabled set to true only
groupChatsDisplayMode	chatrooms display mode	string	"embedded" and "fixed" values allowed
groupChatsFixedWindowWidth	fixed window width for a fixed chatroom	number	valid for groupChatsDisplayMode set to "fixed" only
groupChatsFixedWindowHeight	fixed window height for a fixed chatroom	number	valid for groupChatsDisplayMode set to "fixed" only
groupChatsLayout	chatroom user list display mode	string	"compact" and "stacked" values allowed
autoScrollEnabled	a flag indicating whether to enable autoscroll when new messages are posted	boolean	-
conversationsDisplayMode	private chats display mode	string	"embedded" and "fixed" values allowed
conversationsFixedWindowWidth	fixed window width for a fixed chatroom	number	valid for conversationsDisplayMode set to "fixed" only
conversationsFixedWindowHeight	fixed window height for a fixed chatroom	number	valid for conversationsDisplayMode set to "fixed" only
popOutButtonEnabled	a flag indicating whether to enable the popout button	boolean	-
customRawCss	custom CSS definitions	string	should contain a vaild CSS (do not include `<style>` tag)
chatLogo	chat logo image	string	should be a value valid for `src` attribute of HTML `<img>` tag (e.g. url or base64 encoded image)

ChatweeManager.SetChatProperty