Added in API level 9
Deprecated in API level 31

Listener

class Listener
kotlin.Any
   ↳ android.net.sip.SipSession.Listener

Listener for events relating to a SIP session, such as when a session is being registered ("on registering") or a call is outgoing ("on calling").

Many of these events are also received by SipAudioCall.Listener.

Summary

Public constructors

Public methods
open Unit

Called when the peer is busy during session initialization.
open Unit
onCallChangeFailed(session: SipSession!, errorCode: Int, errorMessage: String!)

Called when an error occurs during session modification negotiation.
open Unit

Called when the session is terminated.
open Unit
onCallEstablished(session: SipSession!, sessionDescription: String!)

Called when the session is established.
open Unit
onCalling(session: SipSession!)

Called when an INVITE request is sent to initiate a new call.
open Unit
onError(session: SipSession!, errorCode: Int, errorMessage: String!)

Called when an error occurs during session initialization and termination.
open Unit

Called when a registration request is sent.
open Unit
onRegistrationDone(session: SipSession!, duration: Int)

Called when registration is successfully done.
open Unit
onRegistrationFailed(session: SipSession!, errorCode: Int, errorMessage: String!)

Called when the registration fails.
open Unit

Called when the registration gets timed out.
open Unit
onRinging(session: SipSession!, caller: SipProfile!, sessionDescription: String!)

Called when an INVITE request is received.
open Unit

Called when a RINGING response is received for the INVITE request sent

Public constructors

Listener

Listener()

Public methods

onCallBusy

Added in API level 9
open fun onCallBusy(session: SipSession!): Unit

Deprecated: Deprecated in Java.

Called when the peer is busy during session initialization.

Parameters
session SipSession!: the session object that carries out the transaction

onCallChangeFailed

Added in API level 9
open fun onCallChangeFailed(
    session: SipSession!, 
    errorCode: Int, 
    errorMessage: String!
): Unit

Deprecated: Deprecated in Java.

Called when an error occurs during session modification negotiation.

Parameters
session SipSession!: the session object that carries out the transaction
errorCode Int: error code defined in SipErrorCode
errorMessage String!: error message

onCallEnded

Added in API level 9
open fun onCallEnded(session: SipSession!): Unit

Deprecated: Deprecated in Java.

Called when the session is terminated.

Parameters
session SipSession!: the session object that is associated with the dialog

onCallEstablished

Added in API level 9
open fun onCallEstablished(
    session: SipSession!, 
    sessionDescription: String!
): Unit

Deprecated: Deprecated in Java.

Called when the session is established.

Parameters
session SipSession!: the session object that is associated with the dialog
sessionDescription String!: the peer's session description

onCalling

Added in API level 9
open fun onCalling(session: SipSession!): Unit

Deprecated: Deprecated in Java.

Called when an INVITE request is sent to initiate a new call.

Parameters
session SipSession!: the session object that carries out the transaction

onError

Added in API level 9
open fun onError(
    session: SipSession!, 
    errorCode: Int, 
    errorMessage: String!
): Unit

Deprecated: Deprecated in Java.

Called when an error occurs during session initialization and termination.

Parameters
session SipSession!: the session object that carries out the transaction
errorCode Int: error code defined in SipErrorCode
errorMessage String!: error message

onRegistering

Added in API level 9
open fun onRegistering(session: SipSession!): Unit

Deprecated: Deprecated in Java.

Called when a registration request is sent.

Parameters
session SipSession!: the session object that carries out the transaction

onRegistrationDone

Added in API level 9
open fun onRegistrationDone(
    session: SipSession!, 
    duration: Int
): Unit

Deprecated: Deprecated in Java.

Called when registration is successfully done.

Parameters
session SipSession!: the session object that carries out the transaction
duration Int: duration in second before the registration expires

onRegistrationFailed

Added in API level 9
open fun onRegistrationFailed(
    session: SipSession!, 
    errorCode: Int, 
    errorMessage: String!
): Unit

Deprecated: Deprecated in Java.

Called when the registration fails.

Parameters
session SipSession!: the session object that carries out the transaction
errorCode Int: error code defined in SipErrorCode
errorMessage String!: error message

onRegistrationTimeout

Added in API level 9
open fun onRegistrationTimeout(session: SipSession!): Unit

Deprecated: Deprecated in Java.

Called when the registration gets timed out.

Parameters
session SipSession!: the session object that carries out the transaction

onRinging

Added in API level 9
open fun onRinging(
    session: SipSession!, 
    caller: SipProfile!, 
    sessionDescription: String!
): Unit

Deprecated: Deprecated in Java.

Called when an INVITE request is received.

Parameters
session SipSession!: the session object that carries out the transaction
caller SipProfile!: the SIP profile of the caller
sessionDescription String!: the caller's session description

onRingingBack

Added in API level 9
open fun onRingingBack(session: SipSession!): Unit

Deprecated: Deprecated in Java.

Called when a RINGING response is received for the INVITE request sent

Parameters
session SipSession!: the session object that carries out the transaction