Suggestions

close search

Add Messaging, Voice, and Authentication to your apps with Vonage Communications APIs

Visit the Vonage API Developer Portal

OpenTok.Session.Builder

Used to create a Session instance. More...

Public Member Functions

 Builder (Context context, string apiKey, string sessionId)
 Creates a new Builder instance. More...
Session Build ()
 Creates a Session object. More...

Properties

bool ConnectionEventsSuppressed = false [get, set]
 Prevent connection events (such as ConnectionCreated from being dispatched. The default value is false. More...
bool IpWhitelist = false [get, set]
 Set this to true if the allowed IP list feature is enabled for your project. (This is available as an add-on feature. The default value is false. More...
Uri ProxyUrl [get, set]
 Set this to the URL of the IP proxy server. This is available as an add-on feature. See the OpenTok pricing page and the IP proxy developer guide. More...
IceConfig IceConfig [get, set]
 This property is used by the configurable TURN feature. More...
Context Context [get, set]
 The Content object used to manage resources for the Session. More...
string ApiKey [get, set]
 Your Vonage Video API key. See the your Vonage Video API account page. More...
string SessionId [get, set]
 The Vonage Video API session ID this instance should connect to. For test purposes, you can generate test session by logging into your Vonage Video API account. Use the OpenTok server SDKs to generate session IDs in your shipping application. More...

Detailed Description

Used to create a Session instance.

Instantiate a Builder instance by calling the Builder() constructor. Then (optionally), set properties of the Builder object. Then call the Build() method to create a Session object.

Constructor & Destructor Documentation

◆ Builder()

OpenTok.Session.Builder.Builder ( Context  context,
string  apiKey,
string  sessionId 
)

Creates a new Builder instance.

Parameters
contextThe Content object used to manage resources for the Session.
apiKeyYour Vonage Video API key. See the your Vonage Video API account page.
sessionIdThe Vonage Video API session ID this instance should connect to. For test purposes, you can generate test session by logging into your Vonage Video API account. Use the OpenTok server SDKs to generate session IDs in your shipping application.

Member Function Documentation

◆ Build()

Session OpenTok.Session.Builder.Build ( )

Creates a Session object.

Returns

Property Documentation

◆ ApiKey

string OpenTok.Session.Builder.ApiKey

Your Vonage Video API key. See the your Vonage Video API account page.

◆ ConnectionEventsSuppressed

bool OpenTok.Session.Builder.ConnectionEventsSuppressed = false

Prevent connection events (such as ConnectionCreated from being dispatched. The default value is false.

◆ Context

Context OpenTok.Session.Builder.Context

The Content object used to manage resources for the Session.

◆ IceConfig

IceConfig OpenTok.Session.Builder.IceConfig

This property is used by the configurable TURN feature.

◆ IpWhitelist

bool OpenTok.Session.Builder.IpWhitelist = false

Set this to true if the allowed IP list feature is enabled for your project. (This is available as an add-on feature. The default value is false.

◆ ProxyUrl

Uri OpenTok.Session.Builder.ProxyUrl

Set this to the URL of the IP proxy server. This is available as an add-on feature. See the OpenTok pricing page and the IP proxy developer guide.

◆ SessionId

string OpenTok.Session.Builder.SessionId

The Vonage Video API session ID this instance should connect to. For test purposes, you can generate test session by logging into your Vonage Video API account. Use the OpenTok server SDKs to generate session IDs in your shipping application.