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	Remarks
chatweeLabel	the chat name displayed in the top left corner of the chat window	string	-
chatweeIsActive	a flag indicating whether the chat should be enabled	boolean	-
chatweeMobileIsActive	a flag indicating wheher the chat should be enabled for mobile devices	boolean	-
chatweeForceViewport	a flag indicating whether to apply the responsive layout for mobile devices	boolean	-
chatweeLayout	defines the display mode for the chat	string	"embedded" and "fixed" values allowed
chatweeAutoStart	whether to start the fixed chat maximized by default	boolean	valid for chatweeLayout set to "fixed" only
chatweeDefaultPosition	default fixed chat window position	string	"left" and "right" values allowed, valid for chatweeLayout set to "fixed" only
chatweeDefaultWidth	default window width for fixed mode	number	valid for chatweeLayout set to "fixed" only
chatweeDefaultHeight	default window height for fixed mode	number	valid for chatweeLayout set to "fixed" only
chatweeEmbeddedContainerSelector	DOM selector for the embedded chat's parent	string	valid for chatweeLayout set to "embedded" only
chatweeEmbeddedSize	sizing mode for the embedded chat	string	"auto" and "manual" values allowed, valid for chatweeLayout set to "embedded" only
chatweeDefaultEmbeddedWidth	fixed window width for the embedded chat	number	valid for chatweeLayout set to "embedded" only, valid for chatweeEmbeddedSize set to "manual" only
chatweeDefaultEmbeddedHeight	fixed window height for the embedded chat	number	valid for chatweeLayout set to "embedded" only, valid for chatweeEmbeddedSize set to "manual" only
chatweeSound	a flag indicating whether to allow sound notifications	boolean	-
chatweeConversationsEnabled	a flag indicating whether to allow private conversations	boolean	-
chatweeSmiles	a flag indicating whether to allow emojis	boolean	-
chatweeSharing	a flag indicating whether to allow file sharing	boolean	-
chatweeFacebookEnabled	a flag indicating whether to allow Facebook login	boolean	-
chatweeLoginEnabled	a flag indicating whether to allow Chatwee login	boolean	-
chatweeGuestEnabled	a flag indicating whether to allow guest users	boolean	-
chatweeLoggedUsersOnly	if set the chat is available for logged users only	boolean	-
chatweeAutoLogin	a flag indicating whether to allow auto-login for the guest users	boolean	-
chatweeGuestNamesList	a list of default guest names used for auto-login feature	string	comma separated list of values
chatweeProfanityListEnabled	a flag indicating whether the profanity censorship is enabled	boolean
chatweeStrictProfanity	a flag indicating whether to block messages containing profanity	boolean
chatweeProfanityList	a profanity list	string	comma separated list of values

ChatweeManager.SetChatProperty