Class: BrickFTP::Types::Permission

Inherits:
Struct
  • Object
show all
Includes:
IgnoreUndefinedAttributes
Defined in:
lib/brick_ftp/types/permission.rb

Overview

The permission object

ATTRIBUTE TYPE DESCRIPTION
id integer Globally unique identifier of each permission. Each permission is given an ID automatically upon creation.
user_id integer Unique identifier for the user being granted a permission. Each user is given an ID automatically upon creation. The user_id and group_id fields cannot both be set.
username string Username for the user, if user_id is set. If this value is set during creation and user_id is not set, the user_id is looked up from the username and set. Maximum of 50 characters.
group_id integer Unique identifier for the group being granted a permission. Each group is given an ID automatically upon creation. The user_id and group_id fields cannot both be set.
group_name string Name of the group, if group_id is set. This property is read-only.
path string Folder path for the permission to apply to. This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
permission enum Value must be set to full, readonly, writeonly, previewonly, or history, depending on the type of access to be granted by the Permission.
recursive boolean If set to false, the permission will be non-recursive, and will not apply to subfolders of the folder specified by the path property. Default is true.

See Also:

Instance Attribute Summary collapse

Method Summary

Methods included from IgnoreUndefinedAttributes

#initialize

Instance Attribute Details

#group_id ⇒ Object

Returns the value of attribute group_id

Returns:

  • (Object) —

    the current value of group_id



22
23
24
 
# File 'lib/brick_ftp/types/permission.rb', line 22

def group_id
  @group_id
end

#group_name ⇒ Object

Returns the value of attribute group_name

Returns:

  • (Object) —

    the current value of group_name



22
23
24
 
# File 'lib/brick_ftp/types/permission.rb', line 22

def group_name
  @group_name
end

#id ⇒ Object

Returns the value of attribute id

Returns:

  • (Object) —

    the current value of id



22
23
24
 
# File 'lib/brick_ftp/types/permission.rb', line 22

def id
  @id
end

#path ⇒ Object

Returns the value of attribute path

Returns:

  • (Object) —

    the current value of path



22
23
24
 
# File 'lib/brick_ftp/types/permission.rb', line 22

def path
  @path
end

#permission ⇒ Object

Returns the value of attribute permission

Returns:

  • (Object) —

    the current value of permission



22
23
24
 
# File 'lib/brick_ftp/types/permission.rb', line 22

def permission
  @permission
end

#recursive ⇒ Object

Returns the value of attribute recursive

Returns:

  • (Object) —

    the current value of recursive



22
23
24
 
# File 'lib/brick_ftp/types/permission.rb', line 22

def recursive
  @recursive
end

#user_id ⇒ Object

Returns the value of attribute user_id

Returns:

  • (Object) —

    the current value of user_id



22
23
24
 
# File 'lib/brick_ftp/types/permission.rb', line 22

def user_id
  @user_id
end

#username ⇒ Object

Returns the value of attribute username

Returns:

  • (Object) —

    the current value of username



22
23
24
 
# File 'lib/brick_ftp/types/permission.rb', line 22

def username
  @username
end