summaryrefslogtreecommitdiff
path: root/plugins/org.apache.cordova.file/docs/fileobj/fileobj.md
blob: ee5f1d4baf4cad1efff77ea3e29e875993409fc6 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
---
license: Licensed to the Apache Software Foundation (ASF) under one
         or more contributor license agreements.  See the NOTICE file
         distributed with this work for additional information
         regarding copyright ownership.  The ASF licenses this file
         to you under the Apache License, Version 2.0 (the
         "License"); you may not use this file except in compliance
         with the License.  You may obtain a copy of the License at

           http://www.apache.org/licenses/LICENSE-2.0

         Unless required by applicable law or agreed to in writing,
         software distributed under the License is distributed on an
         "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
         KIND, either express or implied.  See the License for the
         specific language governing permissions and limitations
         under the License.
---

File
====

This object contains attributes of a single file.

Properties
----------

- __name__: The name of the file. _(DOMString)_
- __fullPath__: The full path of the file including the file name. _(DOMString)_
- __type__: The mime type of the file. _(DOMString)_
- __lastModifiedDate__: The last time the file was modified. _(Date)_
- __size__: The size of the file in bytes. _(long)_

Methods
-------

- __slice__: Select only a portion of the file to be read.

Details
-------

The `File` object contains attributes of a single file.  You can get
an instance of a `File` object by calling a `FileEntry` object's
`file()` method.

Supported Platforms
-------------------

- Android
- BlackBerry WebWorks (OS 5.0 and higher)
- iOS
- Windows Phone 7 and 8
- Windows 8

slice
--------------

Return a new `File` object, for which `FileReader` returns only the
specified portion of the file.  Negative values for `start` or `end`
are measured from the end of the file.  Indexes are positioned
relative to the current slice. (See the full example below.)

__Parameters:__

- __start__: The index of the first byte to read, inclusive.
- __end__: The index of the byte after the last one to read.

__Quick Example__

    var slicedFile = file.slice(10, 30);

__Full Example__

    var slice1 = file.slice(100, 400);
    var slice2 = slice1.slice(20, 35);

    var slice3 = file.slice(120, 135);
    // slice2 and slice3 are equivalent.

__Supported Platforms:__

- Android
- iOS