API Reference

Chatvisor.init(...)

/**
Initializes the Chatvisor SDK.
- Parameter tenantId tenant id
- Parameter token token
*/
static func initConfig(tenantId: String, token: String) -> InitConfiguration?
+ (InitConfiguration * _Nullable) initConfigWithTenantId:(NSString * _Nonnull)tenantId token:(NSString * _Nonnull)token;

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;

Request notification permissions

 /**
 Asks for notification authorization on the first call. 
 Registers the application for remote notifications.
 
 Call this function when the permissions should be requested but in any case after initialization.
 Notifications can only be received after this function is executed.
*/
func requestNotificationAuthorization() -> Void
- (void)requestNotificationAuthorization;

Forward user opening notification

 /**
 Opens the chatvisor chat for a received notification.
 
 Call this function in application(_:didReceiveRemoteNotification:) 
 to open the chatvisor chat when the user taps on a chatvisor notification.
*/
func didReceiveRemoteNotification(userInfo: [AnyHashable : Any]) -> Void
- (void)didReceiveRemoteNotificationWithUserInfo:(NSDictionary * _Nonnull)userInfo;

Setup UNUserNotificationCenterDelegate

 /**
Sets the UNUserNotificationCenter delegate.

Call this function from your application(_:willFinishLaunchingWithOptions:) or 
application(_:didFinishLaunchingWithOptions:)
*/
func setupUNUserNotificationCenterDelegate() -> Void
- (void)setupUNUserNotificationCenterDelegate;

Forward notifications when app is in foreground

 /**
 Checks if the chat is already open. If not, it creates a notification.
 
 Call this function in your UNUserNotificationCenter delegate's userNotificationCenter(_:willPresent:withCompletionHandler:).

 This function returns true when it handles the notification and calls the completionHandler, false otherwise.
*/
func processesNotification(notification: UNNotification, withCompletionHandler completionHandler: @escaping (UNNotificationPresentationOptions) -> Void) -> Void
- (BOOL)processesNotificationWithNotification(UNNotification * _Nonnull)notification withCompletionHandler:(void (^ _Nonnull)(UNNotificationPresentationOptions))completionHandler SWIFT_WARN_UNUSED_RESULT;

Initialize Firebase

 /**
Sets the FirebaseMessaging.FIRMessaging delegate.

Call this function from your application(_:willFinishLaunchingWithOptions:) or 
application(_:didFinishLaunchingWithOptions:) if you do already have a custom
UNUserNotificationCenter delegate but no FIRMessaging delegate.

This function is called by initNotifications()
*/
func initFirebase() -> Void
- (void)initFirebase SWIFT_METHOD_FAMILY(none);

Setup Messaging delegate

 /**
Sets the FirebaseMessaging.FIRMessaging delegate.

Call this function from your application(_:willFinishLaunchingWithOptions:) or 
application(_:didFinishLaunchingWithOptions:)
*/
func setupMessagingDelegate() -> Void
- (void)setupMessagingDelegate;

Forward a new device token to the chatvisor SDK

 /**
 Notifies the server about a new mobile device token.
*/
func messaging(_ messaging: Messaging, didReceiveRegistrationToken fcmToken: Data) -> Void
- (void)messaging:(FIRMessaging * _Nonnull)messaging didReceiveRegistrationToken:(NSString * _Nonnull)fcmToken;

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;

Chatvisor.conference()

Start conference

/**
Use this method to start a video conference in the app.
- Parameter conferenceProperties conference properties with customer id
*/
public func start(conferenceProperties: ConferenceProperties)
- (void)startWithConferenceProperties:(ConferenceProperties * _Nonnull)conferenceProperties;
/**
Use this method to start a video conference in the app.
- Parameter conferenceProperties conference properties with customer id
- Parameter showInviteDialog shows invite dialog
*/
public func start(conferenceProperties: ConferenceProperties, showInviteDialog: Bool)
- (void)startWithConferenceProperties:<#(ConferenceProperties * _Nonnull)#> showInviteDialog:<#(BOOL)#>

Join conference queue

/**
Use this method to start a video conference in the app.
- Parameter tenantId the tenantId of the user
- Parameter conferenceProperties conference properties with customer id
*/
public func join(conferenceProperties: ConferenceProperties)
- (void)joinWithConferenceProperties:(ConferenceProperties * _Nonnull)conferenceProperties;

Check queue status

/**
Sets a callback for queue status polling. After joining the queue the callback is called every few seconds with the position in the queue.
When the position is -1, the conference should be started by calling start(context, properties).
- Parameter completion pass completion block
*/
public func queueStatus(completion: @escaping (Int)->())
- (void)queueStatusWithCompletion:(void (^ _Nonnull)(NSInteger))completion;
← UsageLicenses →