Class: Aws::ChimeSDKMessaging::Types::ListChannelMessagesRequest

Inherits:

Struct

• Object
• Struct
• Aws::ChimeSDKMessaging::Types::ListChannelMessagesRequest

Includes:

Structure

Defined in:

lib/aws-sdk-chimesdkmessaging/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:next_token]

Instance Attribute Summary

• #channel_arn ⇒ String

  The ARN of the channel.

• #chime_bearer ⇒ String

  The ARN of the ‘AppInstanceUser` or `AppInstanceBot` that makes the API call.

• #max_results ⇒ Integer

  The maximum number of messages that you want returned.

• #next_token ⇒ String

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

• #not_after ⇒ Time

  The final or ending time stamp for your requested messages.

• #not_before ⇒ Time

  The initial or starting time stamp for your requested messages.

• #sort_order ⇒ String

  The order in which you want messages sorted.

• #sub_channel_id ⇒ String

  The ID of the SubChannel in the request.

Instance Attribute Details

#channel_arn ⇒ String

The ARN of the channel.

Returns:

• (String)

# File 'lib/aws-sdk-chimesdkmessaging/types.rb', line 2205

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

#chime_bearer ⇒ String

The ARN of the ‘AppInstanceUser` or `AppInstanceBot` that makes the API call.

Returns:

• (String)

# File 'lib/aws-sdk-chimesdkmessaging/types.rb', line 2205

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

#max_results ⇒ Integer

The maximum number of messages that you want returned.

Returns:

• (Integer)

# File 'lib/aws-sdk-chimesdkmessaging/types.rb', line 2205

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

#next_token ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-chimesdkmessaging/types.rb', line 2205

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

#not_after ⇒ Time

The final or ending time stamp for your requested messages.

Returns:

• (Time)

# File 'lib/aws-sdk-chimesdkmessaging/types.rb', line 2205

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

#not_before ⇒ Time

The initial or starting time stamp for your requested messages.

Returns:

• (Time)

# File 'lib/aws-sdk-chimesdkmessaging/types.rb', line 2205

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

#sort_order ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-chimesdkmessaging/types.rb', line 2205

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

#sub_channel_id ⇒ String

The ID of the SubChannel in the request.

<note markdown=“1”> Only required when listing the messages in a SubChannel that the user belongs to.

</note>

Returns:

• (String)

# File 'lib/aws-sdk-chimesdkmessaging/types.rb', line 2205

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