Class: BrickFTP::Types::File
- Inherits:
-
Struct
- Object
- Struct
- BrickFTP::Types::File
- Includes:
- IgnoreUndefinedAttributes
- Defined in:
- lib/brick_ftp/types/file.rb
Overview
The file/folder object
ATTRIBUTE | TYPE | DESCRIPTION |
---|---|---|
id | integer | Globally unique identifier of each file. |
path | string | Full path of the file or folder. Maximum of 550 characters. |
display_name | string | Name of the file or folder without path. |
type | enum | Either file or directory (meaning folder). |
size | integer | Size of the file in bytes. Will be 0 for a folder. |
mtime | datetime | Date of the file/folder's last modification. |
provided_mtime | datetime | Client-provided date of the file/folder's last modification. |
crc32 | string | CRC32 for the file, if available. |
md5 | string | MD5 hash for the file, if available. |
region | string | The geographic region that a file is stored in. |
permissions | string | Your permissions on the file/folder. Will be one of the following:p (list/preview only), r (read-only), w (write-only), rw (read/write), rwd (read/write/delete). |
download_uri | string | URL to download the file, if requested. |
subfolders_locked? | integer | A value of 1 indicates that the Lock-subfolders setting is enabled on a folder. |
Instance Attribute Summary collapse
-
#crc32 ⇒ Object
Returns the value of attribute crc32.
-
#display_name ⇒ Object
Returns the value of attribute display_name.
-
#download_uri ⇒ Object
Returns the value of attribute download_uri.
-
#id ⇒ Object
Returns the value of attribute id.
-
#md5 ⇒ Object
Returns the value of attribute md5.
-
#mtime ⇒ Object
Returns the value of attribute mtime.
-
#path ⇒ Object
Returns the value of attribute path.
-
#permissions ⇒ Object
Returns the value of attribute permissions.
-
#provided_mtime ⇒ Object
Returns the value of attribute provided_mtime.
-
#region ⇒ Object
Returns the value of attribute region.
-
#size ⇒ Object
Returns the value of attribute size.
-
#subfolders_locked? ⇒ Object
Returns the value of attribute subfolders_locked?.
-
#type ⇒ Object
Returns the value of attribute type.
Method Summary
Methods included from IgnoreUndefinedAttributes
Instance Attribute Details
#crc32 ⇒ Object
Returns the value of attribute crc32
27 28 29 |
# File 'lib/brick_ftp/types/file.rb', line 27 def crc32 @crc32 end |
#display_name ⇒ Object
Returns the value of attribute display_name
27 28 29 |
# File 'lib/brick_ftp/types/file.rb', line 27 def display_name @display_name end |
#download_uri ⇒ Object
Returns the value of attribute download_uri
27 28 29 |
# File 'lib/brick_ftp/types/file.rb', line 27 def download_uri @download_uri end |
#id ⇒ Object
Returns the value of attribute id
27 28 29 |
# File 'lib/brick_ftp/types/file.rb', line 27 def id @id end |
#md5 ⇒ Object
Returns the value of attribute md5
27 28 29 |
# File 'lib/brick_ftp/types/file.rb', line 27 def md5 @md5 end |
#mtime ⇒ Object
Returns the value of attribute mtime
27 28 29 |
# File 'lib/brick_ftp/types/file.rb', line 27 def mtime @mtime end |
#path ⇒ Object
Returns the value of attribute path
27 28 29 |
# File 'lib/brick_ftp/types/file.rb', line 27 def path @path end |
#permissions ⇒ Object
Returns the value of attribute permissions
27 28 29 |
# File 'lib/brick_ftp/types/file.rb', line 27 def @permissions end |
#provided_mtime ⇒ Object
Returns the value of attribute provided_mtime
27 28 29 |
# File 'lib/brick_ftp/types/file.rb', line 27 def provided_mtime @provided_mtime end |
#region ⇒ Object
Returns the value of attribute region
27 28 29 |
# File 'lib/brick_ftp/types/file.rb', line 27 def region @region end |
#size ⇒ Object
Returns the value of attribute size
27 28 29 |
# File 'lib/brick_ftp/types/file.rb', line 27 def size @size end |
#subfolders_locked? ⇒ Object
Returns the value of attribute subfolders_locked?
27 28 29 |
# File 'lib/brick_ftp/types/file.rb', line 27
def subfolders_locked?
@subfolders_locked?
end
|
#type ⇒ Object
Returns the value of attribute type
27 28 29 |
# File 'lib/brick_ftp/types/file.rb', line 27 def type @type end |