Class: Glassfrog::Action

Inherits:
Base
  • Object
show all
Defined in:
lib/glassfrog/action.rb

Overview

Encapsulates GlassFrog Actions.

Constant Summary collapse

PATH = 
'/actions'
TYPE = 
:actions

Instance Attribute Summary collapse

Attributes inherited from Base

#id

Class Method Summary collapse

Methods inherited from Base

#==, #hashify, #initialize

Methods included from Utils

#extract_id, #parameterize, #symbolize_keys

Constructor Details

This class inherits a constructor from Glassfrog::Base

Instance Attribute Details

#created_at ⇒ String

Returns:

  • (String) 


10
11
12
 
# File 'lib/glassfrog/action.rb', line 10

def created_at
  @created_at
end

#description ⇒ String

Returns:

  • (String) 


10
11
12
 
# File 'lib/glassfrog/action.rb', line 10

def description
  @description
end

#links ⇒ Hash

Returns:

  • (Hash) 


14
15
16
 
# File 'lib/glassfrog/action.rb', line 14

def links
  @links
end

#private_to_circle ⇒ Boolean

Returns:

  • (Boolean) 


12
13
14
 
# File 'lib/glassfrog/action.rb', line 12

def private_to_circle
  @private_to_circle
end

Class Method Details

.get(client, options) ⇒ Array<Glassfrog::Action>

Sends a GET request for Action(s) to GlassFrog.

Parameters:

  • client (Glassfrog::Client) —

    The client that will send the request. Contains the API key.

  • options (Hash, Glassfrog::Base) —

    The options used to find the correct Actions(s).

Returns:



24
25
26
27
 
# File 'lib/glassfrog/action.rb', line 24

def self.get(client, options)
  response = Glassfrog::REST::Get.irregular_get(client, TYPE, PATH, options)
  response[TYPE] ? response[TYPE].map { |object| self.new(object) } : []
end