FileTransferServiceConfiguration
extends Object| java.lang.Object | |
| ↳ | com.gsma.services.rcs.filetransfer.FileTransferServiceConfiguration |
Class Overview
File transfer service configuration
Summary
| Nested Classes | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| enum | FileTransferServiceConfiguration.ImageResizeOption | Enumerated for the Image Resize Option | |||||||||
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| FileTransferServiceConfiguration.ImageResizeOption |
getImageResizeOption()
Returns the image resize option for file transfer in the range: ALWAYS_PERFORM,
ONLY_ABOVE_MAX_SIZE, ASK
| ||||||||||
| long |
getMaxAudioMessageDuration()
Returns the maximum audio message duration.
| ||||||||||
| int |
getMaxFileTransfers()
Returns the max number of simultaneous file transfers
| ||||||||||
| long |
getMaxSize()
Returns the file transfer size limit.
| ||||||||||
| long |
getWarnSize()
Returns the file transfer size threshold when the user should be warned about the potential
charges associated to the transfer of a large file.
| ||||||||||
| boolean |
isAutoAcceptEnabled()
Is file transfer invitation automatically accepted
| ||||||||||
| boolean |
isAutoAcceptInRoamingEnabled()
Is file transfer invitation automatically accepted while in roaming.
| ||||||||||
| boolean |
isAutoAcceptModeChangeable()
is default Auto Accept mode (both in normal or roaming modes) changeable
| ||||||||||
| boolean |
isGroupFileTransferSupported()
Returns True if group file transfer is supported, else returns False.
| ||||||||||
| void |
setAutoAccept(boolean enable)
Sets the Auto Accept Mode of a File Transfer configuration.
| ||||||||||
| void |
setAutoAcceptInRoaming(boolean enable)
Sets the Auto Accept Mode of a File Transfer configuration while roaming.
| ||||||||||
| void |
setImageResizeOption(FileTransferServiceConfiguration.ImageResizeOption option)
Sets the image resize option for file transfer.
| ||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.lang.Object
| |||||||||||
Public Methods
public FileTransferServiceConfiguration.ImageResizeOption getImageResizeOption ()
Returns the image resize option for file transfer in the range: ALWAYS_PERFORM, ONLY_ABOVE_MAX_SIZE, ASK
Returns
- ImageResizeOption instance
Throws
| RcsGenericException |
|---|
public long getMaxAudioMessageDuration ()
Returns the maximum audio message duration.
Returns
- long maximum audio message duration
Throws
| RcsGenericException |
|---|
public int getMaxFileTransfers ()
Returns the max number of simultaneous file transfers
Returns
- int the max number of simultaneous file transfers
Throws
| RcsGenericException |
|---|
public long getMaxSize ()
Returns the file transfer size limit. It returns 0 if there is no limitation.
Returns
- long Size in bytes
Throws
| RcsGenericException |
|---|
public long getWarnSize ()
Returns the file transfer size threshold when the user should be warned about the potential charges associated to the transfer of a large file. It returns 0 if there no need to warn.
Returns
- long Size in bytes
Throws
| RcsGenericException |
|---|
public boolean isAutoAcceptEnabled ()
Is file transfer invitation automatically accepted
Returns
- boolean Returns true if File Transfer is automatically accepted else returns false
Throws
| RcsGenericException |
|---|
public boolean isAutoAcceptInRoamingEnabled ()
Is file transfer invitation automatically accepted while in roaming.
This parameter is only applicable if auto accept is active for File Transfer in normal conditions (see isAutoAcceptEnabled).
Returns
- boolean Returns true if File Transfer is automatically accepted while in roaming else returns false
Throws
| RcsGenericException |
|---|
public boolean isAutoAcceptModeChangeable ()
is default Auto Accept mode (both in normal or roaming modes) changeable
Returns
- boolean True if client is allowed to change the default Auto Accept mode (both in normal or roaming modes)
Throws
| RcsGenericException |
|---|
public boolean isGroupFileTransferSupported ()
Returns True if group file transfer is supported, else returns False.
Returns
- boolean True if group file transfer is supported, else returns False.
Throws
| RcsGenericException |
|---|
public void setAutoAccept (boolean enable)
Sets the Auto Accept Mode of a File Transfer configuration.
The Auto Accept Mode can only be modified by client application if isAutoAcceptChangeable is
true.
Parameters
| enable | True if file transfer is auto accepted |
|---|
Throws
| RcsPersistentStorageException | |
| RcsGenericException | |
| RcsPersistentStorageException |
public void setAutoAcceptInRoaming (boolean enable)
Sets the Auto Accept Mode of a File Transfer configuration while roaming.
The AutoAcceptInRoaming can only be modified by client application if
isAutoAcceptModeChangeable is true and if the AutoAccept Mode in normal conditions is true.
Parameters
| enable | True if file transfer is auto accepted in roaming |
|---|
Throws
| RcsPermissionDeniedException | |
| RcsPersistentStorageException | |
| RcsGenericException | |
| RcsPermissionDeniedException | |
| RcsPersistentStorageException |
public void setImageResizeOption (FileTransferServiceConfiguration.ImageResizeOption option)
Sets the image resize option for file transfer.
Parameters
| option | the image resize option for file transfer. |
|---|
Throws
| RcsGenericException |
|---|