Class: Seam::Resources::Device::Properties::OnlineTimeFrameOptions

Inherits:
BaseResource
  • Object
show all
Defined in:
lib/seam/resources/device.rb

Defined Under Namespace

Classes: TimePairs

Instance Attribute Summary collapse

Attributes inherited from BaseResource

#client, #data

Instance Method Summary collapse

Methods inherited from BaseResource

#[], date_accessor, #initialize, #inspect, load_from_response, resource_accessor, resource_accessors, resource_list_accessor, resource_list_accessors, #update_from_response

Constructor Details

This class inherits a constructor from Seam::Resources::BaseResource

Instance Attribute Details

#display_name ⇒ String

Label for this option. For a single-option device, the product name (for example, algoPIN or SmartPIN); for a multi-option device, a label that distinguishes it (for example, Hourly or Fixed start times).

Returns:

  • (String) 


1041
1042
1043
 
# File 'lib/seam/resources/device.rb', line 1041

def display_name
  @display_name
end

#end_date_recurrence_rule ⇒ String?

iCalendar recurrence rule (RRULE) that the end date must fall on. Constrains which calendar dates are selectable, independent of the time-of-day rules.

Returns:

  • (String, nil) 


1044
1045
1046
 
# File 'lib/seam/resources/device.rb', line 1044

def end_date_recurrence_rule
  @end_date_recurrence_rule
end

#matching_start_end_time ⇒ Boolean?

When true, the start and end must fall at the same time of day (the caller picks which). Mutually exclusive with time_pairs.

Returns:

  • (Boolean, nil) 


1047
1048
1049
 
# File 'lib/seam/resources/device.rb', line 1047

def matching_start_end_time
  @matching_start_end_time
end

#max_duration ⇒ String?

Maximum duration this option covers, as an ISO 8601 duration (for example, PT672H or P367D). Omitted when there is no maximum.

Returns:

  • (String, nil) 


1050
1051
1052
 
# File 'lib/seam/resources/device.rb', line 1050

def max_duration
  @max_duration
end

#min_duration ⇒ String?

Minimum duration this option covers, as an ISO 8601 duration (for example, PT1H or P29D). Omitted when there is no minimum.

Returns:

  • (String, nil) 


1053
1054
1055
 
# File 'lib/seam/resources/device.rb', line 1053

def min_duration
  @min_duration
end

#start_date_recurrence_rule ⇒ String?

iCalendar recurrence rule (RRULE) that the start date must fall on (for example, FREQ=MONTHLY;BYDAY=1MO,3MO). Constrains which calendar dates are selectable, independent of the time-of-day rules.

Returns:

  • (String, nil) 


1056
1057
1058
 
# File 'lib/seam/resources/device.rb', line 1056

def start_date_recurrence_rule
  @start_date_recurrence_rule
end

#time_zone ⇒ String?

IANA time zone for interpreting time_pairs and the date recurrence rules. Present only when the option fixes times or dates.

Returns:

  • (String, nil) 


1059
1060
1061
 
# File 'lib/seam/resources/device.rb', line 1059

def time_zone
  @time_zone
end

Instance Method Details

#time_pairs ⇒ Array<TimePairs>

Fixed start/end time pairings the caller chooses from. Mutually exclusive with matching_start_end_time.

Returns:



1038
 
# File 'lib/seam/resources/device.rb', line 1038

resource_list_accessor :time_pairs, TimePairs