Class: TXTextControl::ReportingCloud::APIKey

Inherits:
Object
  • Object
show all
Defined in:
lib/txtextcontrol/reportingcloud/api_key.rb

Overview

Represents a ReportingCloud API key object.

Author:

  • Thorsten Kummerow (@thomerow)

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(key, is_active = true) ⇒ APIKey

Returns a new instance of APIKey

Parameters:

  • key (String) —

    The actual API Key that belongs to the account.

  • is_active (Boolean) (defaults to: true) —

    Specifies whether the API Key is active or not (not used yet).



26
27
28
29
 
# File 'lib/txtextcontrol/reportingcloud/api_key.rb', line 26

def initialize(key, is_active = true)
  self.key = key
  @is_active = is_active
end

Instance Attribute Details

#is_active ⇒ Boolean

Specifies whether the API Key is active or not (not used yet).

Returns:

  • (Boolean) —

    the current value of is_active



21
22
23
 
# File 'lib/txtextcontrol/reportingcloud/api_key.rb', line 21

def is_active
  @is_active
end

#key ⇒ String

The actual API Key that belongs to the account.

Returns:

  • (String) —

    the current value of key



21
22
23
 
# File 'lib/txtextcontrol/reportingcloud/api_key.rb', line 21

def key
  @key
end