API reference

WitWebSocketAdapter Class

Extends MonoBehaviour

Implements Meta.Voice.Net.PubSub.IPubSubAdapter, Lib.Wit.Runtime.Utilities.Logging.ILogSource

A publish/subscribe MonoBehaviour adapter for WitWebSocketClients

Fields

WebSocketProvider : IWitWebSocketClientProvider

The script used to provide the WitWebSocketClient

Signature

IWitWebSocketClientProvider Meta.Voice.Net.WebSockets.WitWebSocketAdapter.WebSocketProvider

Properties

Logger : IVLogger [Get]	Signature IVLogger Meta.Voice.Net.WebSockets.WitWebSocketAdapter.Logger
OnSubscribed : UnityEvent [Get]	Callback when successfully subscribed to the current topic Signature UnityEvent Meta.Voice.Net.WebSockets.WitWebSocketAdapter.OnSubscribed
OnUnsubscribed : UnityEvent [Get]	Callback when successfully unsubscribed from the current topic Signature UnityEvent Meta.Voice.Net.WebSockets.WitWebSocketAdapter.OnUnsubscribed
Settings : PubSubSettings [Get][Set]	The various pub sub settings available Signature PubSubSettings Meta.Voice.Net.WebSockets.WitWebSocketAdapter.Settings
SubscriptionState : PubSubSubscriptionState [Get]	The current subscription state of the adapter Signature PubSubSubscriptionState Meta.Voice.Net.WebSockets.WitWebSocketAdapter.SubscriptionState
WebSocketClient : IWitWebSocketClient [Get]	The current web socket client Signature IWitWebSocketClient Meta.Voice.Net.WebSockets.WitWebSocketAdapter.WebSocketClient

Events

OnProcessForwardedResponse : WitWebSocketResponseProcessor	An event callback for processing a response for a request originating on a different client with a topic this client adapter has subscribed to. Signature WitWebSocketResponseProcessor Meta.Voice.Net.WebSockets.WitWebSocketAdapter.OnProcessForwardedResponse
OnRequestGenerated : Action< IWitWebSocketRequest >	Callback when a request is generated for the subscribed topic Signature Action<IWitWebSocketRequest> Meta.Voice.Net.WebSockets.WitWebSocketAdapter.OnRequestGenerated
OnTopicSubscriptionStateChange : Action< PubSubSubscriptionState >	Event callback for subscription state change Signature Action<PubSubSubscriptionState> Meta.Voice.Net.WebSockets.WitWebSocketAdapter.OnTopicSubscriptionStateChange

Protected Methods

ApplySubscriptionPerTopic ( topicId , subscriptionState )	Handle currently set topic id subscription changes only Signature virtual void Meta.Voice.Net.WebSockets.WitWebSocketAdapter.ApplySubscriptionPerTopic(string topicId, PubSubSubscriptionState subscriptionState) Parameters `topicId: string` `subscriptionState: PubSubSubscriptionState` Returns `void`
DetermineSubscriptionState ()	Determines the current subscription state Signature PubSubSubscriptionState Meta.Voice.Net.WebSockets.WitWebSocketAdapter.DetermineSubscriptionState() Returns `PubSubSubscriptionState`
HandleRequestGenerated ( topicId , request )	Signature virtual void Meta.Voice.Net.WebSockets.WitWebSocketAdapter.HandleRequestGenerated(string topicId, IWitWebSocketRequest request) Parameters `topicId: string` `request: IWitWebSocketRequest` Returns `void`
OnDestroy ()	Signature virtual void Meta.Voice.Net.WebSockets.WitWebSocketAdapter.OnDestroy() Returns `void`
OnDisable ()	Signature virtual void Meta.Voice.Net.WebSockets.WitWebSocketAdapter.OnDisable() Returns `void`
OnEnable ()	Signature virtual void Meta.Voice.Net.WebSockets.WitWebSocketAdapter.OnEnable() Returns `void`
RaiseProcessForwardedResponse ( topicId , requestId , clientUserId , responseChunk )	Signature virtual bool Meta.Voice.Net.WebSockets.WitWebSocketAdapter.RaiseProcessForwardedResponse(string topicId, string requestId, string clientUserId, WitChunk responseChunk) Parameters `topicId: string` `requestId: string` `clientUserId: string` `responseChunk: WitChunk` Returns `bool`

Methods

SendRequest ( request )	Send a request with a specified topic Signature void Meta.Voice.Net.WebSockets.WitWebSocketAdapter.SendRequest(IWitWebSocketRequest request) Parameters `request: IWitWebSocketRequest` Returns `void`
SetClientProvider ( clientProvider )	Safely sets the new web socket client provider if possible Signature void Meta.Voice.Net.WebSockets.WitWebSocketAdapter.SetClientProvider(IWitWebSocketClientProvider clientProvider) Parameters `clientProvider: IWitWebSocketClientProvider` Returns `void`
SetSettings ( settings )	Set the pubsub settings, unsubscribe to the previous & subscribe to a new Signature void Meta.Voice.Net.WebSockets.WitWebSocketAdapter.SetSettings(PubSubSettings settings) Parameters `settings: PubSubSettings` Returns `void`