API Reference
Chatvisor.coBrowsing()
Start session
/**
Starts a CoBrowsing session using the supplied user id and token
- Parameter userId: The id of the tenant
- Parameter token: A token generated by the Chatvisor backend
*/
func start(with userId: String, and token: String) -> Void
- (void)startWith:(NSString*)userId and:(NSString*)token;
Stop session
/**
Disconnects the current cobrowsing-session
*/
func stop() -> Void
- (void)stop;
Chatvisor.liveView()
Start session
/**
Starts a LiveView session using the supplied user id and token
- Parameter userId: The id of the tenant
- Parameter token: A token generated by the Chatvisor backend
*/
func start(with userId: String, and token: String) -> Void
- (void)startWith:(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
*/
func open(for tenantId: String) -> Void
- (void)openFor:(NSString * _Nonnull)tenantId;
Chatvisor.user()
Tag user
/**
Tags the current or any following session with the given user information until clear() is called
*/
func tag(_ tag: ActiveUser) -> Void
- (void)tag:(ActiveUser * _Nonnull);
Clear tag
/**
Clears a user tag
*/
func clear() -> Void
- (void)clear;