Reference
type
IActiveUser Namespace
Xamarin.LiveView.Abstractions
method
WithAssignedUser(assignedUser) Summary
Set the assigned user of the active user.
Returns
Returns the active user object.
Parameters
Name | Type | Description |
---|---|---|
assignedUser | System.String | The assigned user of the user which should be set. |
method
WithEmail(email) Summary
Set the email of the active user.
Returns
Returns the active user object.
Parameters
Name | Type | Description |
---|---|---|
System.String | The email of the user which should be set. |
method
WithFirstname(firstname) Summary
Set the firstname of the active user.
Returns
Returns the active user object.
Parameters
Name | Type | Description |
---|---|---|
firstname | System.String | The firstname of the user which should be set. |
method
WithId(id) Summary
Set the id of the active user.
Returns
Returns the active user object.
Parameters
Name | Type | Description |
---|---|---|
id | System.String | The id of the user which should be set. |
method
WithLastname(lastname) Summary
Set the lastname of the active user.
Returns
Returns the active user object.
Parameters
Name | Type | Description |
---|---|---|
lastname | System.String | The lastname of the user which should be set. |
method
WithTags(tags) Summary
Set the tags of the active user.
Returns
Returns the active user object.
Parameters
Name | Type | Description |
---|---|---|
tags | System.String[] | The tags of the user which should be set. |
type
IChatvisor Namespace
Xamarin.LiveView.Abstractions
property
CoBrowsing
property
LiveView
property
User
property
WebChat
method
CreateUser() Parameters
This method has no parameters.
method
Init(tenantId,token) Summary
Initializes the Chatvisor SDK.
Returns
The init configuration object
Parameters
Name | Type | Description |
---|---|---|
tenantId | System.String | tenant id |
token | System.String | token |
type
ICoBrowsing Namespace
Xamarin.LiveView.Abstractions
method
Start() Summary
Starts a CoBrowsing session using the supplied user id and token.
Parameters
This method has no parameters.
method
Stop() Summary
Disconnects the current session.
Parameters
This method has no parameters.
type
IInitConfiguration Namespace
Xamarin.LiveView.Abstractions
method
WithCustomCdnServer(cdnServer) Summary
Set the Chatvisor CDN path if it is different from the default configuration.
Returns
Returns the init configuration object.
Parameters
Name | Type | Description |
---|---|---|
cdnServer | System.String | The name of the CDN server. |
method
WithCustomServer(hostname) Summary
Set the Chatvisor server hostname for on-premise installations
Returns
Returns the init configuration object.
Parameters
Name | Type | Description |
---|---|---|
hostname | System.String | The hostname of the Chatvisor server. |
type
ILiveView Namespace
Xamarin.LiveView.Abstractions
property
ShareId
method
IsConnected() Summary
Returns the current connection status. True if a session was started and server was reached.
Returns
true if connected.
Parameters
This method has no parameters.
method
RegisterCallbacks(startCallback,stopCallback) Summary
Registers callback for start and stop.
Parameters
Name | Type | Description |
---|---|---|
startCallback | Xamarin.LiveView.Abstractions.StartCallback | Tag as string |
stopCallback | Xamarin.LiveView.Abstractions.StopCallback | Tag as string |
method
Start() Summary
Starts a LiveView session using the supplied user id and token.
Parameters
This method has no parameters.
method
Stop() Summary
Disconnects the current session.
Parameters
This method has no parameters.
method
Tag(tag) Summary
Tags the current active session with a custom string value.
Parameters
Name | Type | Description |
---|---|---|
tag | System.String | Tag as string. |
type
IUser Namespace
Xamarin.LiveView.Abstractions
method
Clear() Summary
Clears a user tag
Parameters
This method has no parameters.
method
Tag(activeUser) Summary
Tags the current or any following session with the given user information until clear() is called
Parameters
Name | Type | Description |
---|---|---|
activeUser | Xamarin.LiveView.Abstractions.IActiveUser | The active user object. |
type
IWebChat Namespace
Xamarin.LiveView.Abstractions
method
Open(tenantId) Summary
Opens a WebChat overlay.
Parameters
Name | Type | Description |
---|---|---|
tenantId | System.String | tenant id |