Class: Aws::ChimeSDKMessaging::Types::SearchChannelsRequest

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

Overview

Constant Summary collapse

SENSITIVE =
[:next_token]

Instance Attribute Summary collapse

Instance Attribute Details

#chime_bearerString

The ‘AppInstanceUserArn` of the user making the API call.

Returns:

  • (String)


2875
2876
2877
2878
2879
2880
2881
2882
# File 'lib/aws-sdk-chimesdkmessaging/types.rb', line 2875

class SearchChannelsRequest < Struct.new(
  :chime_bearer,
  :fields,
  :max_results,
  :next_token)
  SENSITIVE = [:next_token]
  include Aws::Structure
end

#fieldsArray<Types::SearchField>

A list of the ‘Field` objects in the channel being searched.

Returns:



2875
2876
2877
2878
2879
2880
2881
2882
# File 'lib/aws-sdk-chimesdkmessaging/types.rb', line 2875

class SearchChannelsRequest < Struct.new(
  :chime_bearer,
  :fields,
  :max_results,
  :next_token)
  SENSITIVE = [:next_token]
  include Aws::Structure
end

#max_resultsInteger

The maximum number of channels that you want returned.

Returns:

  • (Integer)


2875
2876
2877
2878
2879
2880
2881
2882
# File 'lib/aws-sdk-chimesdkmessaging/types.rb', line 2875

class SearchChannelsRequest < Struct.new(
  :chime_bearer,
  :fields,
  :max_results,
  :next_token)
  SENSITIVE = [:next_token]
  include Aws::Structure
end

#next_tokenString

The token returned from previous API requests until the number of channels is reached.

Returns:

  • (String)


2875
2876
2877
2878
2879
2880
2881
2882
# File 'lib/aws-sdk-chimesdkmessaging/types.rb', line 2875

class SearchChannelsRequest < Struct.new(
  :chime_bearer,
  :fields,
  :max_results,
  :next_token)
  SENSITIVE = [:next_token]
  include Aws::Structure
end