Class: BrickFTP::Types::File

Inherits:
Struct
  • Object
show all
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.

See Also:

Instance Attribute Summary collapse

Method Summary

Methods included from IgnoreUndefinedAttributes

#initialize

Instance Attribute Details

#crc32 ⇒ Object

Returns the value of attribute crc32

Returns:

  • (Object) —

    the current value of 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

Returns:

  • (Object) —

    the current value of 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

Returns:

  • (Object) —

    the current value of 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

Returns:

  • (Object) —

    the current value of 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

Returns:

  • (Object) —

    the current value of 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

Returns:

  • (Object) —

    the current value of 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

Returns:

  • (Object) —

    the current value of 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

Returns:

  • (Object) —

    the current value of permissions



27
28
29
 
# File 'lib/brick_ftp/types/file.rb', line 27

def permissions
  @permissions
end

#provided_mtime ⇒ Object

Returns the value of attribute provided_mtime

Returns:

  • (Object) —

    the current value of 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

Returns:

  • (Object) —

    the current value of 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

Returns:

  • (Object) —

    the current value of 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?

Returns:

  • (Object) —

    the current value of 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

Returns:

  • (Object) —

    the current value of type



27
28
29
 
# File 'lib/brick_ftp/types/file.rb', line 27

def type
  @type
end