API Reference
Chatvisor.liveView()
Start session
/**
Starts a LiveView session using the supplied user id and token
- Parameter application: UIApplication object of the app
- Parameter userId: The id of the tenant
- Parameter token: A token generated by the Chatvisor backend
*/
func start(for application: UIApplication, authenticatingWith userId: String, and token: String) -> Void
- (void)startFor:(UIApplication*)application authenticatingWith:(NSString*)userId and:(NSString*)token;
Stop session
/**
Disconnects the current session
*/
func stop() -> Void
- (void)stop;
Connection status
/**
Returns the current connection status. True if a session was started and server was reached
- Returns: True if connected
*/
func connected() -> Bool
- (BOOL)connected;
Tag session
/**
Tags the current active session with a custom string value
- Parameter tag: Tag name as string
*/
func tag(_ tag: String) -> Void
- (void)tag:(NSString*)tag;
Register callbacks
/**
Registers callbacks for start and stop
- Parameter startCallback: Called when a session is started by the remote server
- Parameter stopCallback: Called when a session is closed by the remove server
*/
func registerCallbacks(forStart startCallback: @escaping () -> (), andStop stopCallback: @escaping () -> ())
- (void)registerCallbacksForStart:(void (^ _Nonnull)(void))startCallback andStop:(void (^ _Nonnull)(void))stopCallback;
Get share Id
/**
Returns the share Id to identify the session
- Returns:
*/
func shareId() -> String
- (NSString*)shareId;
Chatvisor.webChat()
Show chat
/**
Opens a webChat window as an overlay
- Parameter
*/
func open(for userId: String, and configuration: ChatCionfiguration) -> Void
- (void)openFor:(NSString * _Nonnull)userId and:(ChatConfiguration * _Nonnull)configuration;
Configuration
The configuration objects contains fields to define the appearance of the chat:
title: Title of the chat widget
message: Message displayed under the title
hint: Placeholder text for input field
color: CSS compatible color (eg. #ff0000) to be used as primary color
Chatvisor.configuration()
Set server
Sets the hostname of a custom server (e.g. chatvisor.company.com, chatvisor.company.org:1234). This can for instance be a on-premise installation.
func setServer(hostname: String) -> Void
- (void)setServerWithHostname:(NSString*)hostname;