org.linphone.core

Interface Content

public interface Content

This object holds data that can be embedded in a signaling message.

Use Core.createContent() to create it, and then you should set at least
it's type and subtype and fill the buffer with your data.
A Content can be multipart (contain other contents), have file
information (name, path, size), be encrypted, have custom headers, etc...
It is mainly used to send information through a ChatMessage.

Method Summary

Modifier and Type	Method and Description
void	addContentTypeParameter(java.lang.String name, java.lang.String value) Adds a parameter to the ContentType header.
Content	findPartByHeader(java.lang.String headerName, java.lang.String headerValue) Find a part from a multipart content looking for a part header with a specified value.
byte[]	getBuffer() Get the content data buffer, usually a string.
java.lang.String	getCustomHeader(java.lang.String headerName) Get a custom header value of a content.
java.lang.String	getEncoding() Get the encoding of the data buffer, for example "gzip".
java.lang.String	getFilePath() Get the file transfer filepath set for this content (replace linphone_chat_message_get_file_transfer_filepath).
int	getFileSize() Get the file size if content is either a FileContent or a FileTransferContent.
java.lang.String	getKey() Get the key associated with a RCS file transfer message if encrypted.
int	getKeySize() Get the size of key associated with a RCS file transfer message if encrypted.
java.lang.String	getName() Get the name associated with a RCS file transfer message.
long	getNativePointer() Gets the native pointer used by this class to make native method calls.
Content	getPart(int index) Get a part from a multipart content according to its index.
Content[]	getParts() Get all the parts from a multipart content.
java.lang.String	getPlainFilePath() If the content is an encrypted file, generate a temporary plain copy of the file and returns its paths The caller is responsible to then delete this temporary copy and the returned string.
int	getSize() Get the content data buffer size, excluding null character despite null character is always set for convenience.
java.lang.String	getStringBuffer() Deprecated. 2020-07-01. Use getUtf8Text() instead.
java.lang.String	getSubtype() Get the mime subtype of the content data.
java.lang.String	getType() Get the mime type of the content data.
java.lang.Object	getUserData() Gets the object stored in this object user's data
java.lang.String	getUtf8Text() Get the string content data buffer.
boolean	isFile() Tells whether or not this content contains a file.
boolean	isFileEncrypted() Tells whether or not this content contains an encrypted file.
boolean	isFileTransfer() Tells whether or not this content is a file transfer.
boolean	isMultipart() Tell whether a content is a multipart content.
boolean	isText() Tells whether or not this content contains text.
void	setBuffer(byte[] buffer, int size) Set the content data buffer, usually a string.
void	setEncoding(java.lang.String encoding) Set the encoding of the data buffer, for example "gzip".
void	setFilePath(java.lang.String filePath) Set the file transfer filepath for this content (replace linphone_chat_message_set_file_transfer_filepath).
void	setKey(java.lang.String key, int keyLength) Set the key associated with a RCS file transfer message if encrypted.
void	setName(java.lang.String name) Set the name associated with a RCS file transfer message.
void	setSize(int size) Set the content data size, excluding null character despite null character is always set for convenience.
void	setStringBuffer(java.lang.String buffer) Deprecated. 2020-07-01. Use setUtf8Text(java.lang.String) instead.
void	setSubtype(java.lang.String subtype) Set the mime subtype of the content data.
void	setType(java.lang.String type) Set the mime type of the content data.
void	setUserData(java.lang.Object data) Sets the object to store in this object user's data
void	setUtf8Text(java.lang.String buffer) Get the string content data buffer.
java.lang.String	toString()

Method Detail

getBuffer

@NonNull
byte[] getBuffer()

Get the content data buffer, usually a string.

Returns:

The content data buffer.

getEncoding

@Nullable
java.lang.String getEncoding()

Get the encoding of the data buffer, for example "gzip".

Returns:

The encoding of the data buffer.

setEncoding

void setEncoding(@Nullable
                 java.lang.String encoding)

Set the encoding of the data buffer, for example "gzip".

Parameters:

encoding - The encoding of the data buffer.

getFilePath

@Nullable
java.lang.String getFilePath()

Get the file transfer filepath set for this content (replace
linphone_chat_message_get_file_transfer_filepath).

Returns:

The file path set for this content if it has been set, null otherwise.

setFilePath

void setFilePath(@Nullable
                 java.lang.String filePath)

Set the file transfer filepath for this content (replace
linphone_chat_message_set_file_transfer_filepath).

Parameters:

filePath - the file transfer filepath.

getFileSize

int getFileSize()

Get the file size if content is either a FileContent or a FileTransferContent.

Returns:

The represented file size.

isFile

boolean isFile()

Tells whether or not this content contains a file.

Returns:

true if this content contains a file, false otherwise.

isFileEncrypted

boolean isFileEncrypted()

Tells whether or not this content contains an encrypted file.

Returns:

True is this content contains a file and this file is encrypted, false
otherwise.

isFileTransfer

boolean isFileTransfer()

Tells whether or not this content is a file transfer.

Returns:

true if this content is a file transfer, false otherwise.

isMultipart

boolean isMultipart()

Tell whether a content is a multipart content.

Returns:

A boolean value telling whether the content is multipart or not.

isText

boolean isText()

Tells whether or not this content contains text.

Returns:

true if this content contains plain text, false otherwise.

getKey

@Nullable
java.lang.String getKey()

Get the key associated with a RCS file transfer message if encrypted.

Returns:

The key to encrypt/decrypt the file associated to this content.

getKeySize

int getKeySize()

Get the size of key associated with a RCS file transfer message if encrypted.

Returns:

The key size in bytes

getName

@Nullable
java.lang.String getName()

Get the name associated with a RCS file transfer message.

It is used to store the original filename of the file to be downloaded from
server.

Returns:

The name of the content.

setName

void setName(@Nullable
             java.lang.String name)

Set the name associated with a RCS file transfer message.

It is used to store the original filename of the file to be downloaded from
server.

Parameters:

name - The name of the content.

getParts

@NonNull
Content[] getParts()

Get all the parts from a multipart content.

Returns:

A object holding the part if found, null otherwise.

getPlainFilePath

java.lang.String getPlainFilePath()

If the content is an encrypted file, generate a temporary plain copy of the
file and returns its paths The caller is responsible to then delete this
temporary copy and the returned string.

Returns:

The file path set for this content if it has been set, null otherwise.

getSize

int getSize()

Get the content data buffer size, excluding null character despite null
character is always set for convenience.

Returns:

The content data buffer size.

setSize

void setSize(int size)

Set the content data size, excluding null character despite null character is
always set for convenience.

Parameters:

size - The content data buffer size.

getStringBuffer

@Deprecated
 @NonNull
java.lang.String getStringBuffer()

Deprecated. 2020-07-01. Use getUtf8Text() instead.

Get the string content data buffer.

Returns:

The string content data buffer.

setStringBuffer

@Deprecated
void setStringBuffer(@NonNull
                                 java.lang.String buffer)

Deprecated. 2020-07-01. Use setUtf8Text(java.lang.String) instead.

Set the string content data buffer.

Parameters:

buffer - The string content data buffer in UTF8.

getSubtype

@NonNull
java.lang.String getSubtype()

Get the mime subtype of the content data.

Returns:

The mime subtype of the content data, for example "html".

setSubtype

void setSubtype(@NonNull
                java.lang.String subtype)

Set the mime subtype of the content data.

Parameters:

subtype - The mime subtype of the content data, for example "html".

getType

@NonNull
java.lang.String getType()

Get the mime type of the content data.

Returns:

The mime type of the content data, for example "application".

setType

void setType(@NonNull
             java.lang.String type)

Set the mime type of the content data.

Parameters:

type - The mime type of the content data, for example "application".

getUtf8Text

@Nullable
java.lang.String getUtf8Text()

Get the string content data buffer.

Introduced in 01/07/2020

Returns:

The string content data buffer in UTF8.

setUtf8Text

void setUtf8Text(@Nullable
                 java.lang.String buffer)

Get the string content data buffer.

Introduced in 01/07/2020

Parameters:

buffer - The string content data buffer in UTF8.

addContentTypeParameter

void addContentTypeParameter(@NonNull
                             java.lang.String name,
                             @Nullable
                             java.lang.String value)

Adds a parameter to the ContentType header.

Parameters:

name - the name of the parameter to add.

value - the value of the parameter to add.

findPartByHeader

@Nullable
Content findPartByHeader(@NonNull
                                   java.lang.String headerName,
                                   @NonNull
                                   java.lang.String headerValue)

Find a part from a multipart content looking for a part header with a specified
value.

Parameters:

headerName - The name of the header to look for.

headerValue - The value of the header to look for.

Returns:

A Content object object the part if found, null otherwise.

getCustomHeader

@Nullable
java.lang.String getCustomHeader(@NonNull
                                           java.lang.String headerName)

Get a custom header value of a content.

Parameters:

headerName - The name of the header to get the value from.

Returns:

The value of the header if found, null otherwise.

getPart

@Nullable
Content getPart(int index)

Get a part from a multipart content according to its index.

Parameters:

index - The index of the part to get.

Returns:

A Content object holding the part if found, null otherwise.

setBuffer

void setBuffer(@NonNull
               byte[] buffer,
               int size)

Set the content data buffer, usually a string.

Parameters:

buffer - The content data buffer.

size - The size of the content data buffer.

setKey

void setKey(@NonNull
            java.lang.String key,
            int keyLength)

Set the key associated with a RCS file transfer message if encrypted.

Parameters:

key - The key to be used to encrypt/decrypt file associated to this
content.

keyLength - The lengh of the key.

setUserData

void setUserData(java.lang.Object data)

Sets the object to store in this object user's data

Parameters:

data - the object to store

getUserData

java.lang.Object getUserData()

Gets the object stored in this object user's data

Returns:

the object store if any, null otherwise

getNativePointer

long getNativePointer()

Gets the native pointer used by this class to make native method calls.

Returns:

the nativer pointer, as long

toString

java.lang.String toString()

Overrides:

toString in class java.lang.Object