Class WebRTCConnector

Create an instance of WebRTCConnector class with optional session credentials.

Example

const webRTC = await new WebRTCConnector(topia, {
  credentials: { interactiveNonce: "exampleNonce", assetId: "droppedAssetId", visitorId: 1, urlSlug: "exampleWorld" }
});

Hierarchy (View Summary)

SDKController
- WebRTCConnector

Implements

WebRTCConnectorInterface

Index

Constructors

constructor

new WebRTCConnector(
    topia: Topia,
    urlSlug: string,
    options?: WebRTCConnectorOptionalInterface,
): WebRTCConnector
Parameters
- topia: Topia
- urlSlug: string
- options: WebRTCConnectorOptionalInterface = ...
Returns WebRTCConnector
Overrides SDKController.constructor
- Defined in controllers/WebRTCConnector.ts:27

Properties

credentials

credentials: undefined | InteractiveCredentials

`Optional`jwt

jwt?: string

requestOptions

requestOptions: object

topia

topia: Topia

`Optional`twilioConfig

twilioConfig?: null | object

urlSlug

urlSlug: string

Methods

errorHandler

errorHandler(
    __namedParameters: {
        error?: unknown;
        message?: string;
        params?: object;
        sdkMethod?: string;
    },
): {
    data: {};
    message: string;
    method: string;
    params: object;
    sdkMethod: undefined
    | string;
    stack: string;
    stackTrace: Error;
    status: number;
    success: boolean;
    url: string;
}
Parameters
- __namedParameters: { error?: unknown; message?: string; params?: object; sdkMethod?: string }
Returns {
    data: {};
    message: string;
    method: string;
    params: object;
    sdkMethod: undefined | string;
    stack: string;
    stackTrace: Error;
    status: number;
    success: boolean;
    url: string;
}
Inherited from SDKController.errorHandler
- Defined in controllers/SDKController.ts:97

getTwilioConfig

getTwilioConfig(): Promise<void | ResponseType>
Get twilio

Returns Promise<void | ResponseType>
Example
```
await webRTCConnector.getTwilioConfig();
```
Implementation of WebRTCConnectorInterface.getTwilioConfig
- Defined in controllers/WebRTCConnector.ts:45

topiaPublicApi

topiaPublicApi(): AxiosInstance
Returns AxiosInstance
Inherited from SDKController.topiaPublicApi
- Defined in controllers/SDKController.ts:93

Class WebRTCConnector

Example

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns WebRTCConnector

Properties

credentials

`Optional`jwt

requestOptions

topia

`Optional`twilioConfig

urlSlug

Methods

errorHandler

Parameters

Returns {
    data: {};
    message: string;
    method: string;
    params: object;
    sdkMethod: undefined | string;
    stack: string;
    stackTrace: Error;
    status: number;
    success: boolean;
    url: string;
}

getTwilioConfig

Returns Promise<void | ResponseType>

Example

topiaPublicApi

Returns AxiosInstance

Settings

On This Page

Class WebRTCConnector

Example

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns WebRTCConnector

Properties

credentials

Optionaljwt

requestOptions

topia

OptionaltwilioConfig

urlSlug

Methods

errorHandler

Parameters

Returns { data: {}; message: string; method: string; params: object; sdkMethod: undefined | string; stack: string; stackTrace: Error; status: number; success: boolean; url: string;}

getTwilioConfig

Returns Promise<void | ResponseType>

Example

topiaPublicApi

Returns AxiosInstance

Settings

On This Page

`Optional`jwt

`Optional`twilioConfig

Returns {
data: {};
message: string;
method: string;
params: object;
sdkMethod: undefined | string;
stack: string;
stackTrace: Error;
status: number;
success: boolean;
url: string;
}