Class: ALD::API::UserCollection

Inherits:

Collection

• Object
• Collection
• ALD::API::UserCollection

Includes:

Conditioned

Defined in:

lib/ALD/user_collection.rb

Overview

Public: Represents a collection of users on an ALD server.

Constant Summary

RANGE_CONDITIONS =

Internal: filter conditions that allow specifying a range. See #where.

%w[joined]

ARRAY_CONDITIONS =

Internal: filter conditions that allow specifying an array.

%w[privileges]

LOCAL_CONDITIONS =

Internal: filter conditions that can be handled locally.

%w[name]

Instance Method Summary

• #initialize(api, conditions = {}, data = nil) ⇒ UserCollection constructor

  Internal: Create a new collection instance.

Methods included from Conditioned

#where

Methods inherited from Collection

#[], #each, #initialized?

Constructor Details

#initialize(api, conditions = {}, data = nil) ⇒ UserCollection

Internal: Create a new collection instance. Library consumers should not directly call this, but instead obtain new instances from API#users or #where.

api - the ALD::API instance this collection belongs to conditions - the Hash of conditions users in this collection must meet data - an Array of Hashes containing the data about the users in

the collection. May be nil.

# File 'lib/ALD/user_collection.rb', line 18

def initialize(api, conditions = {}, data = nil)
  super(api, conditions, data)
end