SipMessage

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

```
public class SipMessage
extends Object
```
Holder for a sip message.
It allows to prepare / unpack content values of a SIP message.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`FIELD_BODY` Body / content of the sip message.
`static String`	`FIELD_CONTACT` Contact of the sip message.
`static String`	`FIELD_DATE` Reception date of the message.
`static String`	`FIELD_FROM` From / sender.
`static String`	`FIELD_FROM_FULL` Non canonical sip from
`static String`	`FIELD_ID` Primary key id.
`static String`	`FIELD_MIME_TYPE` Mime type of the sip message.
`static String`	`FIELD_READ` Read status of the message.
`static String`	`FIELD_STATUS` Latest pager status.
`static String`	`FIELD_TO` To / receiver.
`static String`	`FIELD_TYPE` Way type of the message.
`static String`	`MESSAGE_CONTENT_ITEM_TYPE` Item type for a sip message.
`static String`	`MESSAGE_CONTENT_TYPE` Content type for sip message.
`static Uri`	`MESSAGE_ID_URI_BASE` Base uri for sip message content provider.
`static int`	`MESSAGE_TYPE_FAILED` Failed outgoing message.
`static int`	`MESSAGE_TYPE_INBOX` Message received type.
`static int`	`MESSAGE_TYPE_QUEUED` Message to send later.
`static int`	`MESSAGE_TYPE_SENT` Message sent type.
`static Uri`	`MESSAGE_URI` Uri for content provider of sip message
`static String`	`MESSAGES_TABLE_NAME` Table for sip message.
`static String`	`SELF` Constant to represent self as sender or receiver of the message.
`static int`	`STATUS_NONE` Status unknown for a message.
`static String`	`THREAD_ALIAS` Table for threads.
`static Uri`	`THREAD_ID_URI_BASE` Base uri for thread views.
`static Uri`	`THREAD_URI` Uri for content provider of threads view.

Constructor Summary

Constructors
Constructor and Description
`SipMessage(Cursor c)` Construct a sip message wrapper from a cursor retrieved with a `ContentProvider` query on `MESSAGES_TABLE_NAME`.
`SipMessage(String aForm, String aTo, String aContact, String aBody, String aMimeType, long aDate, int aType, String aFullFrom)` Construct from raw datas.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`createFromContentValue(ContentValues args)`
`String`	`getBody()` Get the body of the message.
`String`	`getBodyContent()` Get the content of the body without error tag
`ContentValues`	`getContentValues()` Pack the object content value to store
`long`	`getDate()` Get the send/receive date of the message.
`String`	`getDisplayName()` Get the display name of remote party.
`String`	`getErrorContent()` Get optional error of the sip message
`String`	`getFrom()` Get the from of the message.
`String`	`getFullFrom()` Get the complete remote contact from which the message comes.
`String`	`getMimeType()` Get the mime type of the message.
`String`	`getRemoteNumber()` Get the number of the remote party.
`String`	`getTo()` Get to of the message.
`int`	`getType()` Get the type of the message.
`boolean`	`isOutgoing()` Get the way of the message is send by the user of the application
`void`	`setRead(boolean b)` Set the message as read or unread.

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

- Field Detail
  - FIELD_ID
```
public static final String FIELD_ID
```
    Primary key id.
    
    See Also:
    Long, Constant Field Values
  - FIELD_FROM
```
public static final String FIELD_FROM
```
    From / sender.
    
    See Also:
    String, Constant Field Values
  - FIELD_TO
```
public static final String FIELD_TO
```
    To / receiver.
    
    See Also:
    String, Constant Field Values
  - FIELD_CONTACT
```
public static final String FIELD_CONTACT
```
    Contact of the sip message.
    
    See Also:
    Constant Field Values
  - FIELD_BODY
```
public static final String FIELD_BODY
```
    Body / content of the sip message.
    
    See Also:
    String, Constant Field Values
  - FIELD_MIME_TYPE
```
public static final String FIELD_MIME_TYPE
```
    Mime type of the sip message.
    
    See Also:
    String, Constant Field Values
  - FIELD_TYPE
```
public static final String FIELD_TYPE
```
    Way type of the message.
    
    See Also:
    Integer, MESSAGE_TYPE_INBOX, MESSAGE_TYPE_FAILED, MESSAGE_TYPE_QUEUED, MESSAGE_TYPE_SENT, Constant Field Values
  - FIELD_DATE
```
public static final String FIELD_DATE
```
    Reception date of the message.
    
    See Also:
    Long, Constant Field Values
  - FIELD_STATUS
```
public static final String FIELD_STATUS
```
    Latest pager status.
    
    See Also:
    Integer, Constant Field Values
  - FIELD_READ
```
public static final String FIELD_READ
```
    Read status of the message.
    
    See Also:
    Boolean, Constant Field Values
  - FIELD_FROM_FULL
```
public static final String FIELD_FROM_FULL
```
    Non canonical sip from
    
    See Also:
    String, Constant Field Values
  - MESSAGE_TYPE_INBOX
```
public static final int MESSAGE_TYPE_INBOX
```
    Message received type.
    
    See Also:
    Constant Field Values
  - MESSAGE_TYPE_SENT
```
public static final int MESSAGE_TYPE_SENT
```
    Message sent type.
    
    See Also:
    Constant Field Values
  - MESSAGE_TYPE_FAILED
```
public static final int MESSAGE_TYPE_FAILED
```
    Failed outgoing message.
    
    See Also:
    Constant Field Values
  - MESSAGE_TYPE_QUEUED
```
public static final int MESSAGE_TYPE_QUEUED
```
    Message to send later.
    
    See Also:
    Constant Field Values
  - MESSAGES_TABLE_NAME
```
public static final String MESSAGES_TABLE_NAME
```
    Table for sip message.
    
    See Also:
    Constant Field Values
  - MESSAGE_CONTENT_TYPE
```
public static final String MESSAGE_CONTENT_TYPE
```
    Content type for sip message.
    
    See Also:
    Constant Field Values
  - MESSAGE_CONTENT_ITEM_TYPE
```
public static final String MESSAGE_CONTENT_ITEM_TYPE
```
    Item type for a sip message.
    
    See Also:
    Constant Field Values
  - MESSAGE_URI
```
public static final Uri MESSAGE_URI
```
    Uri for content provider of sip message
  - MESSAGE_ID_URI_BASE
```
public static final Uri MESSAGE_ID_URI_BASE
```
    Base uri for sip message content provider.
    To append with FIELD_ID
    
    See Also:
    ContentUris.appendId(android.net.Uri.Builder, long)
  - THREAD_ALIAS
```
public static final String THREAD_ALIAS
```
    Table for threads.
    It's an alias.
    
    See Also:
    Constant Field Values
  - THREAD_URI
```
public static final Uri THREAD_URI
```
    Uri for content provider of threads view.
  - THREAD_ID_URI_BASE
```
public static final Uri THREAD_ID_URI_BASE
```
    Base uri for thread views.
  - STATUS_NONE
```
public static final int STATUS_NONE
```
    Status unknown for a message.
    
    See Also:
    Constant Field Values
  - SELF
```
public static final String SELF
```
    Constant to represent self as sender or receiver of the message.
    
    See Also:
    Constant Field Values
- Constructor Detail
  - SipMessage
```
public SipMessage(String aForm,
          String aTo,
          String aContact,
          String aBody,
          String aMimeType,
          long aDate,
          int aType,
          String aFullFrom)
```
    Construct from raw datas.
    
    Parameters:
    aForm - FIELD_FROM
    aTo - FIELD_TO
    aContact - FIELD_CONTACT
    aBody - FIELD_BODY
    aMimeType - FIELD_MIME_TYPE
    aDate - FIELD_DATE
    aType - FIELD_TYPE
    aFullFrom - FIELD_FROM_FULL
  - SipMessage
```
public SipMessage(Cursor c)
```
    Construct a sip message wrapper from a cursor retrieved with a ContentProvider query on MESSAGES_TABLE_NAME.
    
    Parameters:
    c - the cursor to unpack
- Method Detail
  - getContentValues
```
public ContentValues getContentValues()
```
    Pack the object content value to store
    
    Returns:
    The content value representing the message
  - createFromContentValue
```
public final void createFromContentValue(ContentValues args)
```
  - getFrom
```
public String getFrom()
```
    Get the from of the message.
    
    Returns:
    the From of the sip message
  - getBody
```
public String getBody()
```
    Get the body of the message.
    
    Returns:
    the Body of the message
  - getTo
```
public String getTo()
```
    Get to of the message.
    
    Returns:
    the To of the sip message
  - setRead
```
public void setRead(boolean b)
```
    Set the message as read or unread.
    
    Parameters:
    b - true when read.
  - getDisplayName
```
public String getDisplayName()
```
    Get the display name of remote party.
    
    Returns:
    The remote display name
  - getRemoteNumber
```
public String getRemoteNumber()
```
    Get the number of the remote party.
    
    Returns:
    The remote party number
  - getBodyContent
```
public String getBodyContent()
```
    Get the content of the body without error tag
    
    Returns:
    The body of the sip message
  - getErrorContent
```
public String getErrorContent()
```
    Get optional error of the sip message
    
    Returns:
    The error string repr if any, null otherwise.
  - isOutgoing
```
public boolean isOutgoing()
```
    Get the way of the message is send by the user of the application
    
    Returns:
    true if message is sent by the user of the application
  - getDate
```
public long getDate()
```
    Get the send/receive date of the message.
    
    Returns:
    the date of the send of the message for outgoing, of receive for incoming.
  - getFullFrom
```
public String getFullFrom()
```
    Get the complete remote contact from which the message comes.
    This includes display name.
    
    Returns:
    the sip uri of remote contact as announced when sending this message.
  - getType
```
public int getType()
```
    Get the type of the message.
    
    Returns:
    Message type
    See Also:
    MESSAGE_TYPE_FAILED, MESSAGE_TYPE_INBOX, MESSAGE_TYPE_QUEUED, MESSAGE_TYPE_SENT
  - getMimeType
```
public String getMimeType()
```
    Get the mime type of the message.
    
    Returns:
    the message mime type sent by remote party.

Class SipMessage

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

FIELD_ID

FIELD_FROM

FIELD_TO

FIELD_CONTACT

FIELD_BODY

FIELD_MIME_TYPE

FIELD_TYPE

FIELD_DATE

FIELD_STATUS

FIELD_READ

FIELD_FROM_FULL

MESSAGE_TYPE_INBOX

MESSAGE_TYPE_SENT

MESSAGE_TYPE_FAILED

MESSAGE_TYPE_QUEUED

MESSAGES_TABLE_NAME

MESSAGE_CONTENT_TYPE

MESSAGE_CONTENT_ITEM_TYPE

MESSAGE_URI

MESSAGE_ID_URI_BASE

THREAD_ALIAS

THREAD_URI

THREAD_ID_URI_BASE

STATUS_NONE

SELF

Constructor Detail

SipMessage

SipMessage

Method Detail

getContentValues

createFromContentValue

getFrom

getBody

getTo

setRead

getDisplayName

getRemoteNumber

getBodyContent

getErrorContent

isOutgoing

getDate

getFullFrom

getType

getMimeType