Added in API level 9
Deprecated in API level 31

SipProfile


open class SipProfile : Parcelable, Serializable, Cloneable
kotlin.Any
   ↳ android.net.sip.SipProfile

Defines a SIP profile, including a SIP account, domain and server information.

You can create a SipProfile using SipProfile.Builder. You can also retrieve one from a SipSession, using android.net.sip.SipSession#getLocalProfile and SipSession#getPeerProfile.

Summary

Nested classes
open

Helper class for creating a SipProfile.

Inherited constants
Public methods
open Int

open String!

Gets the username for authentication.

open Boolean

Gets the flag of 'Auto Registration'.

open String!

Gets the display name of the user.

open String!

Gets the password.

open Int

Gets the port number of the SIP server.

open String!

Gets the (user-defined) name of the profile.

open String!

Gets the protocol used to connect to the server.

open String!

Gets the network address of the server outbound proxy.

open Boolean

Gets the flag of 'Sending keep-alive'.

open String!

Gets the SIP domain.

open String!

Gets the SIP URI string of this profile.

open String!

Gets the username.

open Unit

Sets the calling process's Uid in the sip service.

open Unit
writeToParcel(out: Parcel, flags: Int)

Properties
static Parcelable.Creator<SipProfile!>!

Public methods

describeContents

Added in API level 9
open fun describeContents(): Int

Deprecated: Deprecated in Java.

Return
Int a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either 0 or android.os.Parcelable#CONTENTS_FILE_DESCRIPTOR

getAuthUserName

Added in API level 12
Deprecated in API level 31
open fun getAuthUserName(): String!

Deprecated: Deprecated in Java.

Gets the username for authentication. If it is null, then the username is used in authentication instead.

Return
String! the authentication username

See Also

getAutoRegistration

Added in API level 9
open fun getAutoRegistration(): Boolean

Deprecated: Deprecated in Java.

Gets the flag of 'Auto Registration'.

Return
Boolean the flag of registering the profile automatically.

getDisplayName

Added in API level 9
open fun getDisplayName(): String!

Deprecated: Deprecated in Java.

Gets the display name of the user.

Return
String! the display name of the user

getPassword

Added in API level 9
open fun getPassword(): String!

Deprecated: Deprecated in Java.

Gets the password.

Return
String! the password

getPort

Added in API level 9
open fun getPort(): Int

Deprecated: Deprecated in Java.

Gets the port number of the SIP server.

Return
Int the port number of the SIP server

getProfileName

Added in API level 9
open fun getProfileName(): String!

Deprecated: Deprecated in Java.

Gets the (user-defined) name of the profile.

Return
String! name of the profile

getProtocol

Added in API level 9
open fun getProtocol(): String!

Deprecated: Deprecated in Java.

Gets the protocol used to connect to the server.

Return
String! the protocol

getProxyAddress

Added in API level 9
open fun getProxyAddress(): String!

Deprecated: Deprecated in Java.

Gets the network address of the server outbound proxy.

Return
String! the network address of the server outbound proxy

getSendKeepAlive

Added in API level 9
open fun getSendKeepAlive(): Boolean

Deprecated: Deprecated in Java.

Gets the flag of 'Sending keep-alive'.

Return
Boolean the flag of sending SIP keep-alive messages.

getSipDomain

Added in API level 9
open fun getSipDomain(): String!

Deprecated: Deprecated in Java.

Gets the SIP domain.

Return
String! the SIP domain

getUriString

Added in API level 9
open fun getUriString(): String!

Deprecated: Deprecated in Java.

Gets the SIP URI string of this profile.

Return
String! the SIP URI string of this profile

getUserName

Added in API level 9
open fun getUserName(): String!

Deprecated: Deprecated in Java.

Gets the username.

Return
String! the username

setCallingUid

Added in API level 30
Deprecated in API level 31
open fun setCallingUid(uid: Int): Unit

Deprecated: Deprecated in Java.

Sets the calling process's Uid in the sip service.

writeToParcel

Added in API level 9
open fun writeToParcel(
    out: Parcel,
    flags: Int
): Unit

Deprecated: Deprecated in Java.

Parameters
dest The Parcel in which the object should be written. This value cannot be null.
flags Int: Additional flags about how the object should be written. May be 0 or PARCELABLE_WRITE_RETURN_VALUE. Value is either 0 or a combination of android.os.Parcelable#PARCELABLE_WRITE_RETURN_VALUE, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES

Properties

CREATOR

Added in API level 9
static val CREATOR: Parcelable.Creator<SipProfile!>!

Deprecated: Deprecated in Java.