oracle.cloud.mobile.sync.mobileEndpoint

Class MobileFile

java.lang.Object

oracle.cloud.mobile.sync.mobileEndpoint.MobileResource

oracle.cloud.mobile.sync.mobileEndpoint.MobileFile

public class MobileFile
extends MobileResource

Represents a file returned by a custom API

Field Summary

Fields inherited from class oracle.cloud.mobile.sync.mobileEndpoint.MobileResource

mobileEndpoint, syncResource

Constructor Summary

Constructors

Constructor and Description
MobileFile()

Method Summary

Modifier and Type	Method and Description
void	deleteResource(boolean deleteIfOffline, MobileEndpointCallback callback) Deletes the file
void	deleteResource(MobileEndpointCallback callback) Deletes the file.
void	initialize(SyncResource syncResource, MobileEndpoint mobileEndpoint, java.io.InputStream dataStream, java.lang.String contentType) Creates a new MobileFile object with specified settings
java.io.InputStream	openDataStream() Gets the stream that can be used to read the file contents
void	saveResource(java.io.InputStream dataStream, java.lang.String contentType, boolean saveIfOffline, MobileEndpointCallback callback) Saves any changes to the file back to the service.
void	saveResource(java.io.InputStream dataStream, java.lang.String contentType, MobileEndpointCallback callback) Saves any changes to the file back to the service.

Methods inherited from class oracle.cloud.mobile.sync.mobileEndpoint.MobileResource

getCurrentSyncPolicy, getLastSyncTime, getResponseHeaders, getSyncResource, getUri, hasConflict, hasOfflineCommitError, hasOfflineUpdates, isPinned, pinResource, reloadResource, reloadResource, setRequestHeaders, setSyncPolicy, unPinResource

Methods inherited from class java.lang.Object

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

Constructor Detail

MobileFile

public MobileFile()

Method Detail

initialize

public void initialize(SyncResource syncResource,
                       MobileEndpoint mobileEndpoint,
                       java.io.InputStream dataStream,
                       java.lang.String contentType)

Creates a new MobileFile object with specified settings

Parameters:

syncResource - Sync Resource

mobileEndpoint - MobileEndPoint API

dataStream - The input stream

contentType - The Content-Type of the stream

openDataStream

public java.io.InputStream openDataStream()

Gets the stream that can be used to read the file contents

Returns:

An InputStream object

saveResource

public void saveResource(java.io.InputStream dataStream,
                         java.lang.String contentType,
                         MobileEndpointCallback callback)

Saves any changes to the file back to the service. Caches the changes locally if offline. Unlike saveResource: with it's saveIfOffline parameter, this method is always influenced by the Update Policy setting

Parameters:

dataStream - The stream whose contents are to be saved

contentType - The Content-Type of the stream

callback - MobileEndpointCallback object used to return result when request completes

saveResource

public void saveResource(java.io.InputStream dataStream,
                         java.lang.String contentType,
                         boolean saveIfOffline,
                         MobileEndpointCallback callback)

Saves any changes to the file back to the service. Caches the changes locally if offline.

Parameters:

dataStream - The stream whose contents are to be saved

contentType - The Content-Type of the stream

saveIfOffline - If the device is online, this parameter has no effect since any save will be written back to the server. If the device is offline and this option is true, the method will cache updates locally and, when the device returns online, sync them back to the remote service. If the device is offline and this option is false, the save will fail. Note the use of this function overrides any UpdatePolicy setting set elsewhere. This parameter is useful in cases such as a one-off save, where you can set the option to false to ensure the new/updated record is saved to MCS or an error is reported instantaneously, so you can immediately act on the result.

callback - MobileEndpointCallback object used to return result when request completes

deleteResource

public void deleteResource(MobileEndpointCallback callback)

Deletes the file. Caches the delete locally if offline. Unlike deleteResource: with it's deleteIfOffline parameter, this method is always influenced by the Update Policy setting

Parameters:

callback - MobileEndpointCallback object used to return result when request completes

deleteResource

public void deleteResource(boolean deleteIfOffline,
                           MobileEndpointCallback callback)

Deletes the file

Parameters:

deleteIfOffline - If set to true, it will cache the delete locally and sync back to the service if the device is offline. Otherwise, it will fail if the device is offline

callback - Callback