com.quickblox.content.model

Class QBFile

java.lang.Object

com.quickblox.core.model.QBEntity

com.quickblox.content.model.QBFile

All Implemented Interfaces:

java.io.Serializable

public class QBFile
extends QBEntity

The QBFile is a QuickBlox file representation

See Also:

Serialized Form

Field Summary

Fields inherited from class com.quickblox.core.model.QBEntity

createdAt, id, updatedAt

Constructor Summary

Constructors

Constructor and Description
QBFile() Constructs a new QBFile object
QBFile(java.lang.Integer id) Constructs a new QBFile object with id
QBFile(java.lang.String uid) Constructs a new QBFile object with uid

Method Summary

Modifier and Type	Method and Description
void	copyFieldsTo(QBEntity entity) Copy the data of all fields to another instance
java.util.Date	getCompletedAt() Gets the completed at date
java.lang.String	getContentType() Gets the content type
QBFileObjectAccess	getFileObjectAccess() Gets the file object access
java.util.Date	getLastReadAccessTime() Gets the last read access time
java.lang.String	getName() Gets the name
java.lang.String	getPrivateUrl() Gets the private url to the file (can be accessed only within QuickBlox environment)
static java.lang.String	getPrivateUrlForUID(java.lang.String uid) Gets the private url to the file (can be accessed only within QuickBlox environment)
java.lang.String	getPublicUrl() Gets the pubic url to the file (can be accessed without session token)
static java.lang.String	getPublicUrlForUID(java.lang.String uid) Gets the pubic url to the file (can be accessed without session token)
int	getSize() Gets the file size
QBFileStatus	getStatus() Gets the status
java.lang.String	getTags() Gets the users' tags to share the file with
java.lang.String	getUid() Gets the uid
java.lang.Boolean	isPublic() Return 'true' if this file is public (can be accessed without session token)
void	setCompletedAt(java.util.Date completedAt) Sets the completed at date
void	setContentType(java.lang.String contentType) Sets the content type
void	setFileObjectAccess(QBFileObjectAccess fileObjectAccess) Sets the file object access
void	setLastReadAccessTime(java.util.Date lastReadAccessTime) Sets the last read access time
void	setName(java.lang.String name) Sets the name
void	setPublic(java.lang.Boolean publicFlag) Sets the visibility of file
void	setSize(int size) Sets the file size
void	setStatus(boolean status) Sets the status
void	setStatus(QBFileStatus status) Sets the status
void	setTags(java.lang.String tags) Sets the users' tags to share the file with
void	setUid(java.lang.String uid) Sets the uid
java.lang.String	toString()

Methods inherited from class com.quickblox.core.model.QBEntity

equals, getCreatedAt, getFCreatedAt, getFUpdatedAt, getId, getUpdatedAt, hashCode, setCreatedAt, setId, setUpdatedAt

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

QBFile

public QBFile()

Constructs a new QBFile object

QBFile

public QBFile(java.lang.Integer id)

Constructs a new QBFile object with id

Parameters:

id - the file ID

QBFile

public QBFile(java.lang.String uid)

Constructs a new QBFile object with uid

Parameters:

uid - the file UID

Method Detail

getUid

public java.lang.String getUid()

Gets the uid

setUid

public void setUid(java.lang.String uid)

Sets the uid

Parameters:

uid - the UID to set

getContentType

public java.lang.String getContentType()

Gets the content type

setContentType

public void setContentType(java.lang.String contentType)

Sets the content type

Parameters:

contentType - the content type value to set

getName

public java.lang.String getName()

Gets the name

setName

public void setName(java.lang.String name)

Sets the name

Parameters:

name - the name to set

getSize

public int getSize()

Gets the file size

setSize

public void setSize(int size)

Sets the file size

Parameters:

size - the size to set

getStatus

public QBFileStatus getStatus()

Gets the status

setStatus

public void setStatus(QBFileStatus status)

Sets the status

Parameters:

status - the status to set

setStatus

public void setStatus(boolean status)

Sets the status

Parameters:

status - the status to set, 'true' means COMPLETE, 'false' means UNCOMPLETE.

getCompletedAt

public java.util.Date getCompletedAt()

Gets the completed at date

setCompletedAt

public void setCompletedAt(java.util.Date completedAt)

Sets the completed at date

Parameters:

completedAt - the completed at date

isPublic

public java.lang.Boolean isPublic()

Return 'true' if this file is public (can be accessed without session token)

setPublic

public void setPublic(java.lang.Boolean publicFlag)

Sets the visibility of file

Parameters:

publicFlag - The value of file's visibility. Set 'true' if the file can be accessed without session token.

getLastReadAccessTime

public java.util.Date getLastReadAccessTime()

Gets the last read access time

setLastReadAccessTime

public void setLastReadAccessTime(java.util.Date lastReadAccessTime)

Sets the last read access time

Parameters:

lastReadAccessTime - the last read access time

getTags

public java.lang.String getTags()

Gets the users' tags to share the file with

setTags

public void setTags(java.lang.String tags)

Sets the users' tags to share the file with

Parameters:

tags - the tags value to set

getFileObjectAccess

public QBFileObjectAccess getFileObjectAccess()

Gets the file object access

setFileObjectAccess

public void setFileObjectAccess(QBFileObjectAccess fileObjectAccess)

Sets the file object access

Parameters:

fileObjectAccess - the file object access

getPublicUrlForUID

public static java.lang.String getPublicUrlForUID(java.lang.String uid)

Gets the pubic url to the file (can be accessed without session token)

Parameters:

uid - the UID of the file

getPrivateUrlForUID

public static java.lang.String getPrivateUrlForUID(java.lang.String uid)

Gets the private url to the file (can be accessed only within QuickBlox environment)

Parameters:

uid - the UID of the file

getPublicUrl

public java.lang.String getPublicUrl()

Gets the pubic url to the file (can be accessed without session token)

getPrivateUrl

public java.lang.String getPrivateUrl()

Gets the private url to the file (can be accessed only within QuickBlox environment)

toString

public java.lang.String toString()

Overrides:

toString in class QBEntity

copyFieldsTo

public void copyFieldsTo(QBEntity entity)

Description copied from class: QBEntity

Copy the data of all fields to another instance

Overrides:

copyFieldsTo in class QBEntity

Parameters:

entity - receiver instance