LeanCloud.Storage.LCFile Class Reference

LCFile is a local representation of a LeanCloud file. More...

Inheritance diagram for LeanCloud.Storage.LCFile:

Public Member Functions
	LCFile ()
	Creates a new file.
	LCFile (string name, byte[] bytes)
	Creates a new file from a byte array.
	LCFile (string name, string path)
	Creates a new file from a local file.
	LCFile (string name, Uri url)
	Creates a new external file from an url. The file content is saved externally, not copied to LeanCloud.
void	AddMetaData (string key, object value)
	Adds metadata.
async Task< LCFile >	Save (Action< long, long > onProgress=null)
	Saves the file to LeanCloud.
new async Task	Delete ()
	Deletes the file from LeanCloud.
string	GetThumbnailUrl (int width, int height, int quality=100, bool scaleToFit=true, string format="png")
	Gets the thumbnail url of an image file.
Public Member Functions inherited from LeanCloud.Storage.LCObject
void	DisableBeforeHook ()
	Disable hooks before saving / updating / deleting LCObject.
void	DisableAfterHook ()
	Disable hooks after saving / updating / deleting LCObject.
void	IgnoreHook (string hookName)
	Ignores the hook for this LCObject.
ReadOnlyCollection< string >	GetUpdatedKeys ()
	Gets the updated keys of this LCObject.
	LCObject (string className)
	Constructs a new LCObject with no data in it. A LCObject constructed in this way will not have an ObjectedId and will not persist in the cloud until Save(bool, LCQuery<LCObject>)) is called.
void	Unset (string key)
	Removes the key.
void	AddRelation (string key, LCObject value)
	Creates a LCRelation<T> value for a key.
void	RemoveRelation (string key, LCObject value)
	Removes a LCRelation<T> value for a key.
void	Increment (string key, object value)
	Atomically increments the value of the given key with amount.
void	Add (string key, object value)
	Atomically adds value to the end of the array key.
void	AddAll (string key, IEnumerable values)
	Atomically adds values to the end of the array key.
void	AddUnique (string key, object value)
	Atomically adds value to the array key, only if not already present.
void	AddAllUnique (string key, IEnumerable values)
	Atomically adds values to the array key, only if not already present.
void	Remove (string key, object value)
	Atomically removes all value from the array key.
void	RemoveAll (string key, IEnumerable values)
	Atomically removes all values from the array key.
async Task< LCObject >	Save (bool fetchWhenSave=false, LCQuery< LCObject > query=null)
	Saves this object to the cloud.
async Task	Delete ()
	Deletes this object in the cloud.
async Task< LCObject >	Fetch (IEnumerable< string > keys=null, IEnumerable< string > includes=null)
	Fetches this object from the cloud.
override string	ToString ()
	Serializes this LCObject to a JSON string.
void	Merge (LCObjectData objectData)

Static Public Member Functions
static LCQuery< LCFile >	GetQuery ()
	Gets LCQuery of LCFile.
Static Public Member Functions inherited from LeanCloud.Storage.LCObject
static LCObject	CreateWithoutData (string className, string objectId)
	Creates a reference to an existing LCObject.
static LCObject	Create (string className)
	Creates a new LCObject.
static async Task< List< LCObject > >	SaveAll (IEnumerable< LCObject > objects)
	Saves each object in the provided list.
static async Task	DeleteAll (IEnumerable< LCObject > objects)
	Deletes each object in the provided list.
static async Task< IEnumerable< LCObject > >	FetchAll (IEnumerable< LCObject > objects)
	Fetches all of the objects in the provided list.
static void	RegisterSubclass< T > (string className, Func< T > constructor, string endpoint=null)
	Registers a custom subclass type with LeanCloud SDK, enabling strong-typing of those LCObjects whenever they appear.
static LCObject	ParseObject (string json)
	Deserializes a JSON string to a LCObject.
static string	GetClassEndpoint (string className)

Static Public Attributes
const string	CLASS_NAME = "_File"
const string	ENDPOINT = "files"

Properties
string	Name [get, set]
	Gets the name of the file.
string	MimeType [get, set]
	Gets the MIME type of the file.
string	Url [get, set]
	Gets the url of the file.
Dictionary< string, object >	MetaData [get, set]
	Gets the metadata of the file.
string	PathPrefix [get, set]
	Gets the path prefix of the file.
Properties inherited from LeanCloud.Storage.LCObject
string	ClassName [get]
	Gets the class name for the LCObject.
string	ObjectId [get]
	Gets the object id. An object id is assigned as soon as an object is saved to the server. The combination of a ClassName and an ObjectId uniquely identifies an object in your application.
DateTime	CreatedAt [get]
	Gets the creation time of this object in the cloud.
DateTime	UpdatedAt [get]
	Gets the latest update time of this object in the cloud.
LCACL	ACL [get, set]
	Gets or sets the LCACL governing this object.
bool	IsDirty [get, set]
object	this[string key] [get, set]
	Gets or sets a value on the object. It is forbidden to name keys with a leading underscore ('_').

Detailed Description

LCFile is a local representation of a LeanCloud file.

Constructor & Destructor Documentation

LCFile() [1/4]

LeanCloud.Storage.LCFile.LCFile ( )

inline

Creates a new file.

LCFile() [2/4]

LeanCloud.Storage.LCFile.LCFile ( string  name, byte[]  bytes  )

inline

Creates a new file from a byte array.

Parameters

name
bytes

LCFile() [3/4]

LeanCloud.Storage.LCFile.LCFile ( string  name, string  path  )

inline

Creates a new file from a local file.

Parameters

name
path

LCFile() [4/4]

LeanCloud.Storage.LCFile.LCFile ( string  name, Uri  url  )

inline

Creates a new external file from an url. The file content is saved externally, not copied to LeanCloud.

Parameters

name
url

Member Function Documentation

AddMetaData()

void LeanCloud.Storage.LCFile.AddMetaData ( string  key, object  value  )

inline

Adds metadata.

Parameters

key
value

Delete()

new async Task LeanCloud.Storage.LCFile.Delete ( )

inline

Deletes the file from LeanCloud.

Returns

GetQuery()

static LCQuery< LCFile > LeanCloud.Storage.LCFile.GetQuery ( )

inlinestatic

Gets LCQuery of LCFile.

Returns

GetThumbnailUrl()

string LeanCloud.Storage.LCFile.GetThumbnailUrl ( int  width, int  height, int  quality = 100, bool  scaleToFit = true, string  format = "png"  )

inline

Gets the thumbnail url of an image file.

Parameters

width
height
quality
scaleToFit
format

Returns

Save()

async Task< LCFile > LeanCloud.Storage.LCFile.Save ( Action< long, long >  onProgress = null )

inline

Saves the file to LeanCloud.

Parameters

onProgress

Returns

Member Data Documentation

CLASS_NAME

const string LeanCloud.Storage.LCFile.CLASS_NAME = "_File"

static

ENDPOINT

const string LeanCloud.Storage.LCFile.ENDPOINT = "files"

static

Property Documentation

MetaData

Dictionary<string, object> LeanCloud.Storage.LCFile.MetaData

getset

Gets the metadata of the file.

MimeType

string LeanCloud.Storage.LCFile.MimeType

getset

Gets the MIME type of the file.

Name

string LeanCloud.Storage.LCFile.Name

getset

Gets the name of the file.

PathPrefix

string LeanCloud.Storage.LCFile.PathPrefix

getset

Gets the path prefix of the file.

Url

string LeanCloud.Storage.LCFile.Url

getset

Gets the url of the file.

---

The documentation for this class was generated from the following file:

• Storage/Storage/Public/LCFile.cs