Class: JSS::UserGroup

Inherits:
Group show all
Defined in:
lib/jss-api/api_object/group/user_group.rb,
lib/jss-api.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
VALID_DATA_KEYS =

these keys, as well as :id and :name, are present in valid API JSON data for this class

[:is_smart, :users ]
MEMBER_CLASS =

this allows the parent Group class to do things right

JSS::User

Constants inherited from Group

Group::GROUP_TYPES

Constants included from Criteriable

Criteriable::CRITERIABLE

Constants included from Updatable

JSS::Updatable::UPDATABLE

Constants included from Creatable

Creatable::CREATABLE

Constants inherited from APIObject

APIObject::DEFAULT_LOOKUP_KEYS, APIObject::REQUIRED_DATA_KEYS

Instance Attribute Summary

Attributes inherited from Group

#is_smart, #members, #notify_on_change, #site

Attributes included from Criteriable

#criteria

Attributes included from Updatable

#need_to_update

Attributes inherited from APIObject

#id, #in_jss, #name, #rest_rsrc

Instance Method Summary collapse

Methods inherited from Group

#add_member, all_smart, all_static, #clear, #create, #criteria=, #delete, #initialize, #member_ids, #member_names, #refresh_members, #remove_member, #size, #update

Methods included from Criteriable

#parse_criteria, #should_update

Methods included from Updatable

#name=, #update

Methods included from Creatable

#create

Methods inherited from APIObject

all, all_ids, all_names, #delete, get_name, #initialize, map_all_ids_to, #save, xml_list

Constructor Details

This class inherits a constructor from JSS::Group

Instance Method Details

#member_email_addresses ⇒ Array<String>

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

Returns:



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

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:



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

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:



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

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:



101
102
103
 
# File 'lib/jss-api/api_object/group/user_group.rb', line 101

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