Class: Aws::Connect::Types::ParticipantTimerValue

Inherits:
Struct
  • Object
show all
Includes:
Structure, Structure::Union
Defined in:
lib/aws-sdk-connect/types.rb

Overview

Note:

ParticipantTimerValue is a union - when making an API calls you must set exactly one of the members.

The value of the timer. Either the timer action (‘Unset` to delete the timer), or the duration of the timer in minutes. Only one value can be set.

For more information about how chat timeouts work, see [Set up chat timeouts for human participants].

[1]: docs.aws.amazon.com/connect/latest/adminguide/setup-chat-timeouts.html

See Also:

Defined Under Namespace

Classes: ParticipantTimerAction, ParticipantTimerDurationInMinutes, Unknown

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#participant_timer_action ⇒ String

The timer action. Currently only one value is allowed: ‘Unset`. It deletes a timer.

Returns:

  • (String) 


15001
15002
15003
15004
15005
15006
15007
15008
15009
15010
15011
15012
 
# File 'lib/aws-sdk-connect/types.rb', line 15001

class ParticipantTimerValue < Struct.new(
  :participant_timer_action,
  :participant_timer_duration_in_minutes,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class ParticipantTimerAction < ParticipantTimerValue; end
  class ParticipantTimerDurationInMinutes < ParticipantTimerValue; end
  class Unknown < ParticipantTimerValue; end
end

#participant_timer_duration_in_minutes ⇒ Integer

The duration of a timer, in minutes.

Returns:

  • (Integer) 


15001
15002
15003
15004
15005
15006
15007
15008
15009
15010
15011
15012
 
# File 'lib/aws-sdk-connect/types.rb', line 15001

class ParticipantTimerValue < Struct.new(
  :participant_timer_action,
  :participant_timer_duration_in_minutes,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class ParticipantTimerAction < ParticipantTimerValue; end
  class ParticipantTimerDurationInMinutes < ParticipantTimerValue; end
  class Unknown < ParticipantTimerValue; end
end

#unknown ⇒ Object

Returns the value of attribute unknown

Returns:

  • (Object) —

    the current value of unknown



15001
15002
15003
 
# File 'lib/aws-sdk-connect/types.rb', line 15001

def unknown
  @unknown
end