Class: Aws::IVSRealTime::Types::ListParticipantsRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/types.rb

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#filter_by_published ⇒ Boolean

Filters the response list to only show participants who published during the stage session. Only one of filterByUserId, filterByPublished, or filterByState can be provided per request.

Returns:

  • (Boolean) 


1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
 
# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/types.rb', line 1082

class ListParticipantsRequest < Struct.new(
  :filter_by_published,
  :filter_by_state,
  :filter_by_user_id,
  :max_results,
  :next_token,
  :session_id,
  :stage_arn)
  SENSITIVE = []
  include Aws::Structure
end

#filter_by_state ⇒ String

Filters the response list to only show participants in the specified state. Only one of filterByUserId, filterByPublished, or filterByState can be provided per request.

Returns:

  • (String) 


1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
 
# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/types.rb', line 1082

class ListParticipantsRequest < Struct.new(
  :filter_by_published,
  :filter_by_state,
  :filter_by_user_id,
  :max_results,
  :next_token,
  :session_id,
  :stage_arn)
  SENSITIVE = []
  include Aws::Structure
end

#filter_by_user_id ⇒ String

Filters the response list to match the specified user ID. Only one of filterByUserId, filterByPublished, or filterByState can be provided per request. A userId is a customer-assigned name to help identify the token; this can be used to link a participant to a user in the customer’s own systems.

Returns:

  • (String) 


1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
 
# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/types.rb', line 1082

class ListParticipantsRequest < Struct.new(
  :filter_by_published,
  :filter_by_state,
  :filter_by_user_id,
  :max_results,
  :next_token,
  :session_id,
  :stage_arn)
  SENSITIVE = []
  include Aws::Structure
end

#max_results ⇒ Integer

Maximum number of results to return. Default: 50.

Returns:

  • (Integer) 


1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
 
# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/types.rb', line 1082

class ListParticipantsRequest < Struct.new(
  :filter_by_published,
  :filter_by_state,
  :filter_by_user_id,
  :max_results,
  :next_token,
  :session_id,
  :stage_arn)
  SENSITIVE = []
  include Aws::Structure
end

#next_token ⇒ String

The first participant to retrieve. This is used for pagination; see the nextToken response field.

Returns:

  • (String) 


1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
 
# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/types.rb', line 1082

class ListParticipantsRequest < Struct.new(
  :filter_by_published,
  :filter_by_state,
  :filter_by_user_id,
  :max_results,
  :next_token,
  :session_id,
  :stage_arn)
  SENSITIVE = []
  include Aws::Structure
end

#session_id ⇒ String

ID of the session within the stage.

Returns:

  • (String) 


1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
 
# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/types.rb', line 1082

class ListParticipantsRequest < Struct.new(
  :filter_by_published,
  :filter_by_state,
  :filter_by_user_id,
  :max_results,
  :next_token,
  :session_id,
  :stage_arn)
  SENSITIVE = []
  include Aws::Structure
end

#stage_arn ⇒ String

Stage ARN.

Returns:

  • (String) 


1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
 
# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/types.rb', line 1082

class ListParticipantsRequest < Struct.new(
  :filter_by_published,
  :filter_by_state,
  :filter_by_user_id,
  :max_results,
  :next_token,
  :session_id,
  :stage_arn)
  SENSITIVE = []
  include Aws::Structure
end