SipProfileState

java.lang.Object
- com.csipsimple.api.SipProfileState

All Implemented Interfaces:

Parcelable, Serializable
```
public class SipProfileState
extends Object
implements Parcelable, Serializable
```
Holder for a sip profile state.
It allows to unpack content values from registration/activation status of a SipProfile.

See Also:
Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from interface android.os.Parcelable
  Parcelable.ClassLoaderCreator<T>, Parcelable.Creator<T>

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`ACCOUNT_ID` Account id.
`static String`	`ACTIVE` Activation state.
`static String`	`ADDED_STATUS` Status of sip stack adding of the account.
`static Parcelable.Creator<SipProfileState>`	`CREATOR` Parcelable creator.
`static String`	`DISPLAY_NAME` Display name of the account.
`static String`	`EXPIRES` Latest know expires time.
`static String[]`	`FULL_PROJECTION`
`static String`	`PJSUA_ID` Identifier for underlying sip stack.
`int`	`primaryKey`
`static String`	`PRIORITY` Priority of the account.
`static String`	`REG_URI` Registration uri of the account.
`static String`	`STATUS_CODE` Status code of the latest registration.
`static String`	`STATUS_TEXT` Status comment of latest registration.
`static String`	`WIZARD` Wizard key.

Fields inherited from interface android.os.Parcelable
CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Constructor Summary

Constructors
Constructor and Description
`SipProfileState()` Should not be used for external use of the API.
`SipProfileState(Cursor c)` Construct a sip state wrapper from a cursor retrieved with a `ContentProvider` query on `SipProfile.ACCOUNT_STATUS_URI`.
`SipProfileState(Parcel in)`
`SipProfileState(SipProfile account)` Should not be used for external use of the API.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`createFromContentValue(ContentValues args)` Fill account state object from content values.
`void`	`createFromDb(Cursor c)` Fill account state object from cursor.
`int`	`describeContents()`
`int`	`getAccountId()` Get the identifier identifier of the account that this state is linked to.
`int`	`getAddedStatus()`
`ContentValues`	`getAsContentValue()` Should not be used for external use of the API.
`static Comparator<SipProfileState>`	`getComparator()` Compare accounts profile states.
`CharSequence`	`getDisplayName()`
`int`	`getExpires()`
`int`	`getPjsuaId()` Should not be used for external use of the API.
`int`	`getPriority()`
`String`	`getRegUri()`
`int`	`getStatusCode()`
`String`	`getStatusText()`
`String`	`getWizard()`
`boolean`	`isActive()`
`boolean`	`isAddedToStack()` Is the account added to sip stack yet?
`boolean`	`isValidForCall()` Is the account valid for sip calls?
`void`	`setActive(boolean active)` Should not be used for external use of the API.
`void`	`setAddedStatus(int addedStatus)` Should not be used for external use of the API.
`void`	`setDatabaseId(int databaseId)`
`void`	`setExpires(int expires)` Should not be used for external use of the API.
`void`	`setPjsuaId(int pjsuaId)` Should not be used for external use of the API.
`void`	`setPriority(int priority)` Should not be used for external use of the API.
`void`	`setRegUri(String regUri)` Should not be used for external use of the API.
`void`	`setStatusCode(int statusCode)` Should not be used for external use of the API.
`void`	`setStatusText(String statusText)` Should not be used for external use of the API.
`void`	`setWizard(String wizard)` Should not be used for external use of the API.
`void`	`writeToParcel(Parcel out, int arg1)`

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - primaryKey
```
public int primaryKey
```
  - ACCOUNT_ID
```
public static final String ACCOUNT_ID
```
    Account id.
    Identifier of the SIP account associated. It's the identifier of the account for the API.
    
    See Also:
    SipProfile.FIELD_ID, Integer, Constant Field Values
  - PJSUA_ID
```
public static final String PJSUA_ID
```
    Identifier for underlying sip stack.
    This is an internal identifier you normally don't need to use when using the api from an external application.
    
    See Also:
    Integer, Constant Field Values
  - WIZARD
```
public static final String WIZARD
```
    Wizard key.
    Wizard identifier associated to the account. This is a shortcut to not have to query SipProfile database
    
    See Also:
    String, Constant Field Values
  - ACTIVE
```
public static final String ACTIVE
```
    Activation state.
    Active state of the account. This is a shortcut to not have to query SipProfile database
    
    See Also:
    Boolean, Constant Field Values
  - STATUS_CODE
```
public static final String STATUS_CODE
```
    Status code of the latest registration.
    SIP code of latest registration.
    
    See Also:
    Integer, Constant Field Values
  - STATUS_TEXT
```
public static final String STATUS_TEXT
```
    Status comment of latest registration.
    Sip comment of latest registration.
    
    See Also:
    String, Constant Field Values
  - ADDED_STATUS
```
public static final String ADDED_STATUS
```
    Status of sip stack adding of the account.
    When the application adds the account to the stack it may fails if the sip profile is invalid.
    
    See Also:
    Integer, Constant Field Values
  - EXPIRES
```
public static final String EXPIRES
```
    Latest know expires time.
    Expires value of latest registration. It's actually usefull to detect that it was unregister testing 0 value. Else it's not necessarily relevant information.
    
    See Also:
    Integer, Constant Field Values
  - DISPLAY_NAME
```
public static final String DISPLAY_NAME
```
    Display name of the account. This is a shortcut to not have to query SipProfile database
    
    See Also:
    Constant Field Values
  - PRIORITY
```
public static final String PRIORITY
```
    Priority of the account. This is a shortcut to not have to query SipProfile database
    
    See Also:
    Constant Field Values
  - REG_URI
```
public static final String REG_URI
```
    Registration uri of the account. This is a shortcut to not have to query SipProfile database
    
    See Also:
    Constant Field Values
  - FULL_PROJECTION
```
public static final String[] FULL_PROJECTION
```
  - CREATOR
```
public static final Parcelable.Creator<SipProfileState> CREATOR
```
    Parcelable creator. So that it can be passed as an argument of the aidl interface
- Constructor Detail
  - SipProfileState
```
public SipProfileState(Parcel in)
```
  - SipProfileState
```
public SipProfileState()
```
    Should not be used for external use of the API. Default constructor.
  - SipProfileState
```
public SipProfileState(SipProfile account)
```
    Should not be used for external use of the API. Constructor on the top of a sip account.
    
    Parameters:
    account - The sip profile to associate this wrapper info to.
  - SipProfileState
```
public SipProfileState(Cursor c)
```
    Construct a sip state wrapper from a cursor retrieved with a ContentProvider query on SipProfile.ACCOUNT_STATUS_URI.
    
    Parameters:
    c - the cursor to unpack
- Method Detail
  - describeContents
```
public int describeContents()
```
    Specified by:
    
    describeContents in interface Parcelable
    
    See Also:
    Parcelable.describeContents()
  - writeToParcel
```
public void writeToParcel(Parcel out,
                 int arg1)
```
    Specified by:
    
    writeToParcel in interface Parcelable
    
    See Also:
    Parcelable.writeToParcel(Parcel, int)
  - createFromDb
```
public final void createFromDb(Cursor c)
```
    Fill account state object from cursor.
    
    Parameters:
    c - cursor on the database queried from SipProfile.ACCOUNT_STATUS_URI
  - createFromContentValue
```
public final void createFromContentValue(ContentValues args)
```
    Fill account state object from content values.
    
    Parameters:
    args - content values to wrap.
  - getAsContentValue
```
public ContentValues getAsContentValue()
```
    Should not be used for external use of the API. Produce content value from the wrapper.
    
    Returns:
    Complete content values from the current wrapper around sip profile state.
  - setDatabaseId
```
public void setDatabaseId(int databaseId)
```
    Parameters:
    databaseId - the databaseId to set
  - getAccountId
```
public int getAccountId()
```
    Get the identifier identifier of the account that this state is linked to.
    
    Returns:
    the accountId identifier of the account : ACCOUNT_ID
  - setPjsuaId
```
public void setPjsuaId(int pjsuaId)
```
    Should not be used for external use of the API.
    
    Parameters:
    pjsuaId - the pjsuaId to set
  - getPjsuaId
```
public int getPjsuaId()
```
    Should not be used for external use of the API.
    
    Returns:
    the pjsuaId PJSUA_ID
  - setWizard
```
public void setWizard(String wizard)
```
    Should not be used for external use of the API.
    
    Parameters:
    wizard - the wizard to set
  - getWizard
```
public String getWizard()
```
    Returns:
    the wizard WIZARD
  - setActive
```
public void setActive(boolean active)
```
    Should not be used for external use of the API.
    
    Parameters:
    active - the active to set
  - isActive
```
public boolean isActive()
```
    Returns:
    the active ACTIVE
  - setStatusCode
```
public void setStatusCode(int statusCode)
```
    Should not be used for external use of the API.
    
    Parameters:
    statusCode - the statusCode to set
  - getStatusCode
```
public int getStatusCode()
```
    Returns:
    the statusCode STATUS_TEXT
  - setStatusText
```
public void setStatusText(String statusText)
```
    Should not be used for external use of the API.
    
    Parameters:
    statusText - the statusText to set
  - getStatusText
```
public String getStatusText()
```
    Returns:
    the statusText STATUS_TEXT
  - setAddedStatus
```
public void setAddedStatus(int addedStatus)
```
    Should not be used for external use of the API.
    
    Parameters:
    addedStatus - the addedStatus to set
  - getAddedStatus
```
public int getAddedStatus()
```
    Returns:
    the addedStatus ADDED_STATUS
  - setExpires
```
public void setExpires(int expires)
```
    Should not be used for external use of the API.
    
    Parameters:
    expires - the expires to set
  - getExpires
```
public int getExpires()
```
    Returns:
    the expires EXPIRES
  - getDisplayName
```
public CharSequence getDisplayName()
```
    Returns:
    the display name DISPLAY_NAME
  - getPriority
```
public int getPriority()
```
    Returns:
    the priority PRIORITY
  - setPriority
```
public void setPriority(int priority)
```
    Should not be used for external use of the API.
    
    Parameters:
    priority -
  - setRegUri
```
public void setRegUri(String regUri)
```
    Should not be used for external use of the API.
    
    Parameters:
    regUri - the regUri to set
  - getRegUri
```
public String getRegUri()
```
    Returns:
    the regUri REG_URI
  - isAddedToStack
```
public boolean isAddedToStack()
```
    Is the account added to sip stack yet?
    
    Returns:
    true if the account has been added to sip stack and has a sip stack id.
  - isValidForCall
```
public boolean isValidForCall()
```
    Is the account valid for sip calls?
    
    Returns:
    true if it should be possible to make a call using the associated account.
  - getComparator
```
public static final Comparator<SipProfileState> getComparator()
```
    Compare accounts profile states.
    
    Returns:
    a comparator instance to compare profile states by priorities.

Class SipProfileState

Nested Class Summary

Nested classes/interfaces inherited from interface android.os.Parcelable

Field Summary

Fields inherited from interface android.os.Parcelable

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

primaryKey

ACCOUNT_ID

PJSUA_ID

WIZARD

ACTIVE

STATUS_CODE

STATUS_TEXT

ADDED_STATUS

EXPIRES

DISPLAY_NAME

PRIORITY

REG_URI

FULL_PROJECTION

CREATOR

Constructor Detail

SipProfileState

SipProfileState

SipProfileState

SipProfileState

Method Detail

describeContents

writeToParcel

createFromDb

createFromContentValue

getAsContentValue

setDatabaseId

getAccountId

setPjsuaId

getPjsuaId

setWizard

getWizard

setActive

isActive

setStatusCode

getStatusCode

setStatusText

getStatusText

setAddedStatus

getAddedStatus

setExpires

getExpires

getDisplayName

getPriority

setPriority

setRegUri

getRegUri

isAddedToStack

isValidForCall

getComparator