org.linphone.core

Interface LinphoneChatMessage

public interface LinphoneChatMessage

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	LinphoneChatMessage.LinphoneChatMessageListener
static class	LinphoneChatMessage.State
static interface	LinphoneChatMessage.StateListener Deprecated.

Method Summary

Methods

Modifier and Type	Method and Description
void	addCustomHeader(String name, String value) Add a custom header into the message.
void	cancelFileTransfer() Cancel an ongoing file transfer attached to this message.
void	destroy() Frees the underlying native resource of the message.
int	downloadFile() Start the download of the file referenced in a LinphoneChatMessage from remote server.
String	getAppData()
String	getCustomHeader(String name) Obtain a header value.
ErrorInfo	getErrorInfo() Returns full error in case of failure when sending message.
String	getExternalBodyUrl() Linphone message can carry external body as defined by rfc2017
LinphoneContent	getFileTransferInformation() Get the file_transfer_information (used by call backs to recover informations during a rcs file transfer)
LinphoneAddress	getFrom() get from address associated to this LinphoneChatMessage
LinphoneAddress	getPeerAddress() get peer address associated to this LinphoneChatMessage
Reason	getReason()
LinphoneChatMessage.State	getStatus() Gets the status of the message
int	getStorageId() Returns the id used to id this message in the database
String	getText() get text associated to this LinphoneChatMessage
long	getTime() Gets the time at which the message was sent
LinphoneAddress	getTo() Get destination address of the LinphoneChatMessage.
boolean	isOutgoing() Returns wether the message has been sent or received
boolean	isRead() Returns wether or not the message has been read
void	putChar(long character) Fulfill a chat message char by char.
void	setAppData(String data) Sets data in the chat message
void	setExternalBodyUrl(String url) Linphone message can carry external body as defined by rfc2017
void	setFileTransferFilepath(String path) Set the path to the file to read from or write to during the file transfer.
void	setListener(LinphoneChatMessage.LinphoneChatMessageListener listener) Set the callbacks associated with the LinphoneChatMessage.
void	store() THIS METHOD IS ONLY USED TO IMPORT OLD MESSAGES, DON'T USE IT FOR ANY OTHER USAGE!

Method Detail

getText

String getText()

get text associated to this LinphoneChatMessage

Returns:

text sent along with the message

getPeerAddress

LinphoneAddress getPeerAddress()

get peer address associated to this LinphoneChatMessage

Returns:

LinphoneAddress peer address

getFrom

LinphoneAddress getFrom()

get from address associated to this LinphoneChatMessage

Returns:

LinphoneAddress from address

getTo

LinphoneAddress getTo()

Get destination address of the LinphoneChatMessage.

Returns:

the LinphoneAddress in the To field of the message.

getExternalBodyUrl

String getExternalBodyUrl()

Linphone message can carry external body as defined by rfc2017

Returns:

return external body url null if not present.

setExternalBodyUrl

void setExternalBodyUrl(String url)

Linphone message can carry external body as defined by rfc2017

Parameters:

url - ex: access-type=URL; URL="http://www.foo.com/file"

addCustomHeader

void addCustomHeader(String name,
                   String value)

Add a custom header into the message.

getCustomHeader

String getCustomHeader(String name)

Obtain a header value.

Parameters:

name -

Returns:

the value of the header, or null if not found.

getTime

long getTime()

Gets the time at which the message was sent

Returns:

the time in milliseconds

getStatus

LinphoneChatMessage.State getStatus()

Gets the status of the message

Returns:

the status of the message

isRead

boolean isRead()

Returns wether or not the message has been read

Returns:

true if it has been read, flase otherwise

isOutgoing

boolean isOutgoing()

Returns wether the message has been sent or received

Returns:

true if the message has been sent, false if it has been received

store

void store()

THIS METHOD IS ONLY USED TO IMPORT OLD MESSAGES, DON'T USE IT FOR ANY OTHER USAGE!

getStorageId

int getStorageId()

Returns the id used to id this message in the database

Returns:

the id used to id this message in the database

getReason

Reason getReason()

Returns:

the reason if response received

getErrorInfo

ErrorInfo getErrorInfo()

Returns full error in case of failure when sending message.

Returns:

an ErrorInfo.

cancelFileTransfer

void cancelFileTransfer()

Cancel an ongoing file transfer attached to this message.(upload or download).

getFileTransferInformation

LinphoneContent getFileTransferInformation()

Get the file_transfer_information (used by call backs to recover informations during a rcs file transfer)

Returns:

a pointer to the LinphoneContent structure or NULL if not present.

setAppData

void setAppData(String data)

Sets data in the chat message

Parameters:

data - to store in the message

getAppData

String getAppData()

Returns:

the data stored in the chat message if any, else null

setFileTransferFilepath

void setFileTransferFilepath(String path)

Set the path to the file to read from or write to during the file transfer.

Parameters:

path - The path to the file to use for the file transfer.

downloadFile

int downloadFile()

Start the download of the file referenced in a LinphoneChatMessage from remote server.

setListener

void setListener(LinphoneChatMessage.LinphoneChatMessageListener listener)

Set the callbacks associated with the LinphoneChatMessage.

putChar

void putChar(long character)
             throws LinphoneCoreException

Fulfill a chat message char by char. Message linked to a Real Time Text Call send char in realtime following RFC 4103/T.140 To commit a message, use #linphone_chat_room_send_message

Parameters:

character - T.140 char

Throws:

LinphoneCoreException

destroy

void destroy()

Frees the underlying native resource of the message. It should not be accessed afterwards. This is for optimizing the memory resources at runtime. Not calling this does not result in a memory leak.