Reference
IActiveUser type
Namespace
Xamarin.LiveView.Abstractions
WithAssignedUser(assignedUser) method
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. |
WithEmail(email) method
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. |
WithFirstname(firstname) method
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. |
WithId(id) method
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. |
WithLastname(lastname) method
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. |
WithTags(tags) method
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. |
IChatvisor type
Namespace
Xamarin.LiveView.Abstractions
CoBrowsing property
LiveView property
User property
WebChat property
CreateUser() method
Parameters
This method has no parameters.
Init(tenantId,token) method
Summary
Initializes the Chatvisor SDK.
Returns
The init configuration object
Parameters
| Name | Type | Description |
|---|---|---|
| tenantId | System.String | tenant id |
| token | System.String | token |
ICoBrowsing type
Namespace
Xamarin.LiveView.Abstractions
Start() method
Summary
Starts a CoBrowsing session using the supplied user id and token.
Parameters
This method has no parameters.
Stop() method
Summary
Disconnects the current session.
Parameters
This method has no parameters.
IInitConfiguration type
Namespace
Xamarin.LiveView.Abstractions
WithCustomCdnServer(cdnServer) method
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. |
WithCustomServer(hostname) method
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. |
ILiveView type
Namespace
Xamarin.LiveView.Abstractions
ShareId property
IsConnected() method
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.
RegisterCallbacks(startCallback,stopCallback) method
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 |
Start() method
Summary
Starts a LiveView session using the supplied user id and token.
Parameters
This method has no parameters.
Stop() method
Summary
Disconnects the current session.
Parameters
This method has no parameters.
Tag(tag) method
Summary
Tags the current active session with a custom string value.
Parameters
| Name | Type | Description |
|---|---|---|
| tag | System.String | Tag as string. |
IUser type
Namespace
Xamarin.LiveView.Abstractions
Clear() method
Summary
Clears a user tag
Parameters
This method has no parameters.
Tag(activeUser) method
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. |
IWebChat type
Namespace
Xamarin.LiveView.Abstractions
Open(tenantId) method
Summary
Opens a WebChat overlay.
Parameters
| Name | Type | Description |
|---|---|---|
| tenantId | System.String | tenant id |