Class: JSS::UserGroup

Inherits:
Group show all
Defined in:
lib/jss/api_object/group/user_group.rb,
lib/jss.rb

Overview

A Mobile Device group in the JSS

See also the parent class JSS::Group

See Also:

Constant Summary collapse

RSRC_BASE =

The base for REST resources of this class

"usergroups"
RSRC_LIST_KEY =

the hash key used for the JSON list output of all objects in the JSS

:user_groups
RSRC_OBJECT_KEY =

The hash key used for the JSON object output. It's also used in various error messages

:user_group
MEMBER_CLASS =

this allows the parent Group class to do things right

JSS::User
ADD_MEMBERS_ELEMENT =

the XML element for immediate member additions via PUT

'user_additions'.freeze
REMOVE_MEMBERS_ELEMENT =

the XML element for immediate member removals via PUT

'user_deletions'.freeze
OBJECT_HISTORY_OBJECT_TYPE =

the object type for this object in the object history table. See APIObject#add_object_history_entry

54

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

This class inherits a constructor from JSS::Group

Instance Attribute Details

#criteria ⇒ JSS::Criteriable::Criteria Originally defined in module Criteriable

Returns the criteria for the instance into which we're mixed.

Returns:

#need_to_update ⇒ Boolean (readonly) Originally defined in module Updatable

Returns do we have unsaved changes?.

Returns:

  • (Boolean) —

    do we have unsaved changes?

Instance Method Details

#member_email_addresses ⇒ Array<String>

Return an array of the email addresses of users in this group

Returns:



137
138
139
 
# File 'lib/jss/api_object/group/user_group.rb', line 137

def member_email_addresses
  @members.map{|m| m[:email_address]}
end

#member_full_names ⇒ Array<String>

Return an array of the full names of users in this group

Returns:



119
120
121
 
# File 'lib/jss/api_object/group/user_group.rb', line 119

def member_full_names
  @members.map{|m| m[:full_name]}
end

#member_phone_numbers ⇒ Array<String>

Return an array of the phone numbers of users in this group

Returns:



128
129
130
 
# File 'lib/jss/api_object/group/user_group.rb', line 128

def member_phone_numbers
  @members.map{|m| m[:phone_number]}
end

#member_usernames ⇒ Array<String>

Return an array of the usernames of users in this group

Returns:



110
111
112
 
# File 'lib/jss/api_object/group/user_group.rb', line 110

def member_usernames
  @members.map{|m| m[:username]}
end