Class default

Static audioCallTypes

Static callDisplayModes

Static callTypes

Static environments

Static instance

Static recordingTypes

Static regions

Static voipHandlingStrategies

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

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

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

disconnect

• disconnect(): void

• Stop the plugin

  Returns void

handlePushNotificationPayload

• handlePushNotificationPayload(payload, success?, error?): void

• Call this method to allow Kaleyra Video to handle a notification!

  IMPORTANT

  For Android no js method will ever be called when the app is closed or in background!

  To handle notifications while in background and/or with app closed you may:

  • use phonegap-plugin-push and set server side a parameter {"force-start": "1"} when the notification is created (This will open the app and put it right away in background and then handle the notifications)
  • Handle yourself the notifications natively, it will allow you to define a different behaviour based on your own logic
  • Define the lines as described in our documentation in your config.xml and Kaleyra Video will handle them for you natively (No handling notification callback via js will ever be called, KaleyraVideo.handlePushNotificationPayload included)

  Parameters

  • payload: string

    notification data payload as String

  • Optional success: (() => void)

    callback

    • • (): void

      • Returns void

  • Optional error: (() => void)

    callback

    • • (): void

      • Returns void

  Returns void

  Throws

  IllegalArgumentError

removeUsersDetails

• removeUsersDetails(): void

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

  Returns void

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

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

state

• state(): Promise<unknown>

• Get the current state of the plugin

  Returns Promise<unknown>

  the state as a promise

verifyCurrentCall

• verifyCurrentCall(verify): void

• Verify the user for the current call

  Parameters

  • verify: boolean

    true if the user is verified, false otherwise

  Returns void

  Throws

  IllegalArgumentError

Static configure

• configure(params): default

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

  Parameters

  • params: KaleyraVideoConfiguration

  Returns default

  Throws

  IllegalArgumentError