com.comapi.chat.model

Class Attachment

java.lang.Object

com.comapi.chat.model.Attachment

public class Attachment
extends java.lang.Object

Attachment to be send with a chat message.

Since:

1.0.1

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	LOCAL_AUTO_CONVERTED_FOLDER
static java.lang.String	LOCAL_PART_TYPE_ERROR
static java.lang.String	LOCAL_PART_TYPE_UPLOADING

Method Summary

Modifier and Type	Method and Description
static Attachment	create(byte[] data, java.lang.String type, java.lang.String folder, java.lang.String name) Create data object to send from a file.
static Attachment	create(java.io.File data, java.lang.String type, java.lang.String folder, java.lang.String name) Create data object to send from a file.
static Attachment	create(java.lang.String data, java.lang.String type, java.lang.String folder, java.lang.String name) Create data object to send from a file.
ContentData	getData() Get content data to upload.
java.lang.Throwable	getError() Get upload content exception.
java.lang.String	getFolder() Get folder to which the attachment was uploaded.
java.lang.String	getId() Get attachment id.
java.lang.String	getName() Get assigned file name.
long	getSize() Get uploaded content size.
java.lang.String	getType() Get attachment mime type.
java.lang.String	getUrl() Get url under which the content is available.
Attachment	setError(java.lang.Throwable error) For internal use.
Attachment	updateWithUploadDetails(UploadContentResponse response) For internal use.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

LOCAL_PART_TYPE_ERROR

public static final java.lang.String LOCAL_PART_TYPE_ERROR

See Also:

Constant Field Values

LOCAL_PART_TYPE_UPLOADING

public static final java.lang.String LOCAL_PART_TYPE_UPLOADING

See Also:

Constant Field Values

LOCAL_AUTO_CONVERTED_FOLDER

public static final java.lang.String LOCAL_AUTO_CONVERTED_FOLDER

See Also:

Constant Field Values

Method Detail

create

public static Attachment create(java.io.File data,
                                java.lang.String type,
                                java.lang.String folder,
                                java.lang.String name)

Create data object to send from a file.

Parameters:

data - File to upload.

type - Mime type of the data.

Returns:

Data object to send.

create

public static Attachment create(byte[] data,
                                java.lang.String type,
                                java.lang.String folder,
                                java.lang.String name)

Create data object to send from a file.

Parameters:

data - Raw data bytes to upload.

type - Mime type of the data.

Returns:

Data object to send.

create

public static Attachment create(java.lang.String data,
                                java.lang.String type,
                                java.lang.String folder,
                                java.lang.String name)

Create data object to send from a file.

Parameters:

data - Base64 encoded data to upload.

type - Mime type of the data.

Returns:

Data object to send.

getData

public ContentData getData()

Get content data to upload.

Returns:

Content data to upload.

getFolder

public java.lang.String getFolder()

Get folder to which the attachment was uploaded.

Returns:

Folder to which the attachment was uploaded.

getId

public java.lang.String getId()

Get attachment id.

Returns:

Attachment id.

getType

public java.lang.String getType()

Get attachment mime type.

Returns:

Attachment mime type.

getUrl

public java.lang.String getUrl()

Get url under which the content is available.

Returns:

Url under which the content is available.

getSize

public long getSize()

Get uploaded content size.

Returns:

Uploaded content size.

getName

public java.lang.String getName()

Get assigned file name.

Returns:

File name.

updateWithUploadDetails

public Attachment updateWithUploadDetails(UploadContentResponse response)

For internal use. Update attachment details with upload APIs response.

Parameters:

response - Upload content APIs response.

Returns:

Updated attachment.

setError

public Attachment setError(java.lang.Throwable error)

For internal use. Set upload content exception.

Parameters:

error - Upload content exception.

Returns:

Updated attachment.

getError

public java.lang.Throwable getError()

Get upload content exception.

Returns:

Upload content exception.