Class: Aws::Chime::Types::ListChannelMessagesRequest

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

Overview

Note:

When making an API call, you may pass ListChannelMessagesRequest data as a hash:

{
  channel_arn: "ChimeArn", # required
  sort_order: "ASCENDING", # accepts ASCENDING, DESCENDING
  not_before: Time.now,
  not_after: Time.now,
  max_results: 1,
  next_token: "NextToken",
  chime_bearer: "ChimeArn",
}

Constant Summary collapse

SENSITIVE =
[:next_token]

Instance Attribute Summary collapse

Instance Attribute Details

#channel_arnString

The ARN of the channel.

Returns:

  • (String)


6254
6255
6256
6257
6258
6259
6260
6261
6262
6263
6264
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/types.rb', line 6254

class ListChannelMessagesRequest < Struct.new(
  :channel_arn,
  :sort_order,
  :not_before,
  :not_after,
  :max_results,
  :next_token,
  :chime_bearer)
  SENSITIVE = [:next_token]
  include Aws::Structure
end

#chime_bearerString

The AppInstanceUserArn of the user that makes the API call.

Returns:

  • (String)


6254
6255
6256
6257
6258
6259
6260
6261
6262
6263
6264
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/types.rb', line 6254

class ListChannelMessagesRequest < Struct.new(
  :channel_arn,
  :sort_order,
  :not_before,
  :not_after,
  :max_results,
  :next_token,
  :chime_bearer)
  SENSITIVE = [:next_token]
  include Aws::Structure
end

#max_resultsInteger

The maximum number of messages that you want returned.

Returns:

  • (Integer)


6254
6255
6256
6257
6258
6259
6260
6261
6262
6263
6264
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/types.rb', line 6254

class ListChannelMessagesRequest < Struct.new(
  :channel_arn,
  :sort_order,
  :not_before,
  :not_after,
  :max_results,
  :next_token,
  :chime_bearer)
  SENSITIVE = [:next_token]
  include Aws::Structure
end

#next_tokenString

The token passed by previous API calls until all requested messages are returned.

Returns:

  • (String)


6254
6255
6256
6257
6258
6259
6260
6261
6262
6263
6264
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/types.rb', line 6254

class ListChannelMessagesRequest < Struct.new(
  :channel_arn,
  :sort_order,
  :not_before,
  :not_after,
  :max_results,
  :next_token,
  :chime_bearer)
  SENSITIVE = [:next_token]
  include Aws::Structure
end

#not_afterTime

The final or ending time stamp for your requested messages.

Returns:

  • (Time)


6254
6255
6256
6257
6258
6259
6260
6261
6262
6263
6264
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/types.rb', line 6254

class ListChannelMessagesRequest < Struct.new(
  :channel_arn,
  :sort_order,
  :not_before,
  :not_after,
  :max_results,
  :next_token,
  :chime_bearer)
  SENSITIVE = [:next_token]
  include Aws::Structure
end

#not_beforeTime

The initial or starting time stamp for your requested messages.

Returns:

  • (Time)


6254
6255
6256
6257
6258
6259
6260
6261
6262
6263
6264
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/types.rb', line 6254

class ListChannelMessagesRequest < Struct.new(
  :channel_arn,
  :sort_order,
  :not_before,
  :not_after,
  :max_results,
  :next_token,
  :chime_bearer)
  SENSITIVE = [:next_token]
  include Aws::Structure
end

#sort_orderString

The order in which you want messages sorted. Default is Descending, based on time created.

Returns:

  • (String)


6254
6255
6256
6257
6258
6259
6260
6261
6262
6263
6264
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/types.rb', line 6254

class ListChannelMessagesRequest < Struct.new(
  :channel_arn,
  :sort_order,
  :not_before,
  :not_after,
  :max_results,
  :next_token,
  :chime_bearer)
  SENSITIVE = [:next_token]
  include Aws::Structure
end