Class VxClient

Inheritance
object
VxClient
Implements
Inherited Members
Namespace: VivoxUnity
Assembly: VivoxUnity.dll
Syntax
public class VxClient : IDisposable

Fields

appId

A three letter appId that should be set to UNI. Caution: Do not set this value. Contact your Vivox representative for more information.

Declaration
public const string appId = "UNI"
Field Value
Type Description
string

defaultRealm

Declaration
public string defaultRealm
Field Value
Type Description
string

vivoxDebug

Declaration
public VivoxDebug vivoxDebug
Field Value
Type Description
VivoxDebug

Properties

Instance

Declaration
public static VxClient Instance { get; }
Property Value
Type Description
VxClient

Started

Declaration
public bool Started { get; }
Property Value
Type Description
bool

Methods

BeginIssueRequest(vx_req_base_t, AsyncCallback)

Declaration
public IAsyncResult BeginIssueRequest(vx_req_base_t request, AsyncCallback callback)
Parameters
Type Name Description
vx_req_base_t request
AsyncCallback callback
Returns
Type Description
IAsyncResult

Cleanup()

Declaration
public void Cleanup()

Dispose()

Declaration
public void Dispose()

Dispose(bool)

Declaration
protected virtual void Dispose(bool disposing)
Parameters
Type Name Description
bool disposing

EndIssueRequest(IAsyncResult)

Declaration
public vx_resp_base_t EndIssueRequest(IAsyncResult result)
Parameters
Type Name Description
IAsyncResult result
Returns
Type Description
vx_resp_base_t

~VxClient()

Declaration
protected ~VxClient()

GetRandomChannelUri(string, string)

Declaration
public static string GetRandomChannelUri(string prefix, string realm)
Parameters
Type Name Description
string prefix
string realm
Returns
Type Description
string

GetRandomUserId(string)

Declaration
public static string GetRandomUserId(string prefix)
Parameters
Type Name Description
string prefix
Returns
Type Description
string

GetRandomUserIdEx(string, string)

Declaration
public static string GetRandomUserIdEx(string prefix, string issuer)
Parameters
Type Name Description
string prefix
string issuer
Returns
Type Description
string

GetVersion()

Declaration
public static string GetVersion()
Returns
Type Description
string

Start(VivoxConfig)

This method is used to start VxClient. Most implementations should use Client instead of VxClient

Declaration
public void Start(VivoxConfig config = null)
Parameters
Type Name Description
VivoxConfig config

Optional: config to set on initialize.

Start(vx_sdk_config_t)

Note: It is recommended that you use Start(VivoxConfig config) instead of this method. This method is used to start VxClient. Most implementation should use Client instead of VxClient

Declaration
public void Start(vx_sdk_config_t config)
Parameters
Type Name Description
vx_sdk_config_t config

Optional: config to set on initialize.

Stop()

Declaration
public void Stop()

Events

EventMessageReceived

Declaration
public event VxClient.HandleEventMessage EventMessageReceived
Event Type
Type Description
VxClient.HandleEventMessage

Implements