Class KaleyraVideo

Static instance

addUsersDetails

• addUsersDetails(userDetails): void

• Call this method to provide the details for each user to be used to set up the UI

  Parameters

  • userDetails: UserDetails[]

    array of user details

  Returns void

  Throws

  IllegalArgumentError

clearUserCache

• clearUserCache(): void

• This method allows you to clear all user cached data, such as chat messages and generic information.

  Returns void

connect

• connect(session): void

• Connect the plugin

  Parameters

  • session: Session

    session to connect with

  Returns void

  Throws

  IllegalArgumentError

disconnect

• disconnect(): void

• Stop the plugin

  Returns void

getCurrentVoIPPushToken

• getCurrentVoIPPushToken(): Promise<string>

• This method returns the current voip push token

  Returns Promise<string>

  promise of voipPushToken or undefined if has not been generated yet.

removeUsersDetails

• removeUsersDetails(): void

• Call this method to remove all the user details previously provided.

  Returns void

reset

• reset(): void

• This method allows you to reset the configuration.

  Returns void

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

startCall

• startCall(callOptions): void

• Start Call with the callee defined

  Parameters

  • callOptions: CreateCallOptions

  Returns void

  Throws

  IllegalArgumentError

startCallFrom

• startCallFrom(url): void

• Start Call from url

  Parameters

  • url: string

    received

  Returns void

  Throws

  IllegalArgumentError

startChat

• startChat(userID): void

• Open chat

  Parameters

  • userID: string

    user you want to chat with

  Returns void

  Throws

  IllegalArgumentError

Static configure

• configure(configuration): KaleyraVideo

• Call this method when device is ready to configure the module

  Parameters

  • configuration: KaleyraVideoConfiguration

  Returns KaleyraVideo

  Throws

  IllegalArgumentError