Class default

KaleyraVideo

Hierarchy

EventListener
- default

Properties

`Static` audioCallTypes

audioCallTypes: typeof AudioCallType = AudioCallType

Available audio call types

`Static` callDisplayModes

callDisplayModes: typeof CallDisplayMode = CallDisplayMode

Available display modes

`Static` callTypes

callTypes: typeof CallType = CallType

Available call types

`Static` environments

environments: typeof Environments = Environments

Available environments

`Static` events

events: typeof Events = Events

Available events

`Static` instance

instance: default

To create an instance of the Kaleyra Video invoke the [[configure]] method

`Static` recordingTypes

recordingTypes: typeof RecordingType = RecordingType

Available recording types

`Static` regions

regions: typeof Regions = Regions

Available regions

`Static` voipHandlingStrategies

voipHandlingStrategies: typeof VoipHandlingStrategy = VoipHandlingStrategy

Available voip Handling Strategies

Methods

addUsersDetails

addUsersDetails(userDetails): void
Call this method to provide the details for each user. Kaleyra Video will use this information to set up the UI
Parameters
- userDetails: UserDetails[]
  
  array of user details
Returns void

Throws
IllegalArgumentError
- Defined in www/src/KaleyraVideo.ts:243

clearUserCache

clearUserCache(success?, error?): void
This method allows you to clear all user cached data, such as chat messages and generic Kaleyra Video information.
Parameters
- Optional success: (() => void)
  
  callback
  - - (): void
    - Returns void
- Optional error: ((reason) => void)
  
  callback
  - - (reason): void
    - Parameters
      
      reason: any
      
      Returns void
Returns void
- Defined in www/src/KaleyraVideo.ts:279

connect

connect(session, error?): void
Connect the plugin
Parameters
- session: Session
  
  session to connect with
- Optional error: (() => void)
  
  callback
  - - (): void
    - Returns void
Returns void

Throws
IllegalArgumentError
- Defined in www/src/KaleyraVideo.ts:143

disconnect

disconnect(): void
Stop the plugin

Returns void
- Defined in www/src/KaleyraVideo.ts:165

removeUsersDetails

removeUsersDetails(): void
Call this method to remove all the user details previously provided.

Returns void
- Defined in www/src/KaleyraVideo.ts:255

reset

reset(success?, error?): void
This method allows you to reset the configuration.
Parameters
- Optional success: (() => void)
  
  callback
  - - (): void
    - Returns void
- Optional error: ((reason) => void)
  
  callback
  - - (reason): void
    - Parameters
      
      reason: any
      
      Returns void
Returns void
- Defined in www/src/KaleyraVideo.ts:174

setDisplayModeForCurrentCall

setDisplayModeForCurrentCall(mode): void
Set the UI display mode for the current call
Parameters
- mode: CallDisplayMode
  
  FOREGROUND, FOREGROUND_PICTURE_IN_PICTURE, BACKGROUND
Returns void

Throws
IllegalArgumentError
- Defined in www/src/KaleyraVideo.ts:211

startCall

startCall(callOptions): void
Start Call with the callee defined
Parameters
- callOptions: CreateCallOptions
Returns void

Throws
IllegalArgumentError
- Defined in www/src/KaleyraVideo.ts:193

startCallFrom

startCallFrom(url): void
Start Call from url
Parameters
- url: string
  
  received
Returns void

Throws
IllegalArgumentError
- Defined in www/src/KaleyraVideo.ts:226

startChat

startChat(userID): void
Open chat
Parameters
- userID: string
  
  user you want to chat with
Returns void

Throws
IllegalArgumentError
- Defined in www/src/KaleyraVideo.ts:264

state

state(): Promise<unknown>
Get the current state of the plugin

Returns Promise<unknown>
the state as a promise
- Defined in www/src/KaleyraVideo.ts:182

`Static` configure

configure(params): default
Call this method when device is ready to configure the plugin
Parameters
- params: KaleyraVideoConfiguration
Returns default

Throws
IllegalArgumentError
- Defined in www/src/KaleyraVideo.ts:87

Class default

Hierarchy

Index

Properties

Methods

Properties

Static audioCallTypes

Static callDisplayModes

Static callTypes

Static environments

Static events

Static instance

Static recordingTypes

Static regions

Static voipHandlingStrategies

Methods

addUsersDetails

Parameters

userDetails: UserDetails[]

Returns void

Throws

clearUserCache

Parameters

Optional success: (() => void)

Returns void

Optional error: ((reason) => void)

Parameters

reason: any

Returns void

Returns void

connect

Parameters

session: Session

Optional error: (() => void)

Returns void

Returns void

Throws

disconnect

Returns void

removeUsersDetails

Returns void

reset

Parameters

Optional success: (() => void)

Returns void

Optional error: ((reason) => void)

Parameters

reason: any

Returns void

Returns void

setDisplayModeForCurrentCall

Parameters

mode: CallDisplayMode

Returns void

Throws

startCall

Parameters

callOptions: CreateCallOptions

Returns void

Throws

startCallFrom

Parameters

url: string

Returns void

Throws

startChat

Parameters

userID: string

Returns void

Throws

state

Returns Promise<unknown>

Static configure

Parameters

params: KaleyraVideoConfiguration

Returns default

Throws

Settings

Member Visibility

Theme

`Static` audioCallTypes

`Static` callDisplayModes

`Static` callTypes

`Static` environments

`Static` events

`Static` instance

`Static` recordingTypes

`Static` regions

`Static` voipHandlingStrategies

`Optional` success: (() => void)

`Optional` error: ((reason) => void)

`Optional` error: (() => void)

`Optional` success: (() => void)

`Optional` error: ((reason) => void)

`Static` configure