Class: BrickFTP::Types::Group

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

Overview

The group object

ATTRIBUTE TYPE DESCRIPTION
id integer Globally unique identifier of each group. Each group is given an ID automatically upon creation.
name string Name of the group. This is how the group will be displayed on the site. Maximum of 50 characters.
notes text You may use this property to store any additional information you require. There are no restrictions on its formatting.
user_ids comma-separated integers IDs of the users that are in this group.
usernames string Usernames of the users that are in this group.
admin_ids comma-separated integers IDs of the users that are in this group and are administrators of this group.

See Also:

Instance Attribute Summary collapse

Method Summary

Methods included from IgnoreUndefinedAttributes

#initialize

Instance Attribute Details

#admin_ids ⇒ Object

Returns the value of attribute admin_ids

Returns:

  • (Object) —

    the current value of admin_ids



20
21
22
 
# File 'lib/brick_ftp/types/group.rb', line 20

def admin_ids
  @admin_ids
end

#id ⇒ Object

Returns the value of attribute id

Returns:

  • (Object) —

    the current value of id



20
21
22
 
# File 'lib/brick_ftp/types/group.rb', line 20

def id
  @id
end

#name ⇒ Object

Returns the value of attribute name

Returns:

  • (Object) —

    the current value of name



20
21
22
 
# File 'lib/brick_ftp/types/group.rb', line 20

def name
  @name
end

#notes ⇒ Object

Returns the value of attribute notes

Returns:

  • (Object) —

    the current value of notes



20
21
22
 
# File 'lib/brick_ftp/types/group.rb', line 20

def notes
  @notes
end

#user_ids ⇒ Object

Returns the value of attribute user_ids

Returns:

  • (Object) —

    the current value of user_ids



20
21
22
 
# File 'lib/brick_ftp/types/group.rb', line 20

def user_ids
  @user_ids
end

#usernames ⇒ Object

Returns the value of attribute usernames

Returns:

  • (Object) —

    the current value of usernames



20
21
22
 
# File 'lib/brick_ftp/types/group.rb', line 20

def usernames
  @usernames
end