com.ciscowebex.androidsdk.message

Class LocalFile

java.lang.Object

com.ciscowebex.androidsdk.message.LocalFile

public class LocalFile
extends java.lang.Object

A data type represents a local file.

Since:

1.4.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LocalFile.Thumbnail A data type represents a thumbnail of this local file.

Constructor Summary

Constructors

Constructor and Description
LocalFile(java.io.File file) Constructs a LocalFile object out of a local file.
LocalFile(java.io.File file, java.lang.String mime, LocalFile.Thumbnail thumbnail, MessageClient.ProgressHandler progressHandler) Constructs a LocalFile object out of a local File.

Method Summary

Modifier and Type	Method and Description
java.io.File	getFile() Returns the local File object to be uploaded.
java.lang.String	getMimeType() Returns the MIME type of this file.
java.lang.String	getName() Returns the display name of the uploaded file.
java.lang.String	getPath() Returns the local path to the file to be uploaded..
MessageClient.ProgressHandler	getProgressHandler() Returns the MessageClient.ProgressHandler used when uploading this file.
long	getSize() Returns the size in bytes of the file.
LocalFile.Thumbnail	getThumbnail() Return the thumbnail for the local file.
void	setFile(java.io.File file) Deprecated.
void	setMimeType(java.lang.String mimeType) Deprecated.
void	setName(java.lang.String name) Deprecated.
void	setPath(java.lang.String path) Deprecated.
void	setProgressHandler(MessageClient.ProgressHandler progressHandler) Deprecated.
void	setSize(long size) Deprecated.
void	setThumbnail(LocalFile.Thumbnail thumbnail) Deprecated.

Methods inherited from class java.lang.Object

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

Constructor Detail

LocalFile

public LocalFile(@NonNull
                 java.io.File file)

Constructs a LocalFile object out of a local file.

Parameters:

file - An existing local file.

LocalFile

public LocalFile(@NonNull
                 java.io.File file,
                 @Nullable
                 java.lang.String mime,
                 @Nullable
                 LocalFile.Thumbnail thumbnail,
                 @Nullable
                 MessageClient.ProgressHandler progressHandler)

Constructs a LocalFile object out of a local File.

Parameters:

file - An existing local file.

mime - The MIME type of the file, according to RFC6838.

thumbnail - The thumbnail for the local file. If not null, the thumbnail will be uploaded with the local file.

progressHandler - The progress indicator callback for uploading progresses.

Since:

2.1.0

Method Detail

getFile

public java.io.File getFile()

Returns the local File object to be uploaded.

Returns:

The local File object to be uploaded.

getPath

public java.lang.String getPath()

Returns the local path to the file to be uploaded..

Returns:

The local path to the file.

getName

public java.lang.String getName()

Returns the display name of the uploaded file.

Returns:

The display name of the uploaded file.

getSize

public long getSize()

Returns the size in bytes of the file.

Returns:

The size in bytes of the file

getMimeType

public java.lang.String getMimeType()

Returns the MIME type of this file.

Returns:

The MIME type of this file. Null if no MIME type is unavailable.

getProgressHandler

public MessageClient.ProgressHandler getProgressHandler()

Returns the MessageClient.ProgressHandler used when uploading this file.

Returns:

The MessageClient.ProgressHandler. Null if no MessageClient.ProgressHandler is set.

getThumbnail

public LocalFile.Thumbnail getThumbnail()

Return the thumbnail for the local file.

Returns:

The thumbnail for the local file.

setFile

@Deprecated
public void setFile(java.io.File file)

Deprecated.

setPath

@Deprecated
public void setPath(java.lang.String path)

Deprecated.

setName

@Deprecated
public void setName(java.lang.String name)

Deprecated.

setSize

@Deprecated
public void setSize(long size)

Deprecated.

setMimeType

@Deprecated
public void setMimeType(java.lang.String mimeType)

Deprecated.

setProgressHandler

@Deprecated
public void setProgressHandler(MessageClient.ProgressHandler progressHandler)

Deprecated.

setThumbnail

@Deprecated
public void setThumbnail(LocalFile.Thumbnail thumbnail)

Deprecated.