Class: Aws::Ivschat::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::Ivschat::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-ivschat/lib/aws-sdk-ivschat/client.rb
Overview
An API client for Ivschat. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::Ivschat::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#create_chat_token(params = {}) ⇒ Types::CreateChatTokenResponse
Creates an encrypted token that is used by a chat participant to establish an individual WebSocket chat connection to a room.
-
#create_logging_configuration(params = {}) ⇒ Types::CreateLoggingConfigurationResponse
Creates a logging configuration that allows clients to store and record sent messages.
-
#create_room(params = {}) ⇒ Types::CreateRoomResponse
Creates a room that allows clients to connect and pass messages.
-
#delete_logging_configuration(params = {}) ⇒ Struct
Deletes the specified logging configuration.
-
#delete_message(params = {}) ⇒ Types::DeleteMessageResponse
Sends an event to a specific room which directs clients to delete a specific message; that is, unrender it from view and delete it from the client’s chat history.
-
#delete_room(params = {}) ⇒ Struct
Deletes the specified room.
-
#disconnect_user(params = {}) ⇒ Struct
Disconnects all connections using a specified user ID from a room.
-
#get_logging_configuration(params = {}) ⇒ Types::GetLoggingConfigurationResponse
Gets the specified logging configuration.
-
#get_room(params = {}) ⇒ Types::GetRoomResponse
Gets the specified room.
-
#list_logging_configurations(params = {}) ⇒ Types::ListLoggingConfigurationsResponse
Gets summary information about all your logging configurations in the AWS region where the API request is processed.
-
#list_rooms(params = {}) ⇒ Types::ListRoomsResponse
Gets summary information about all your rooms in the AWS region where the API request is processed.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Gets information about AWS tags for the specified ARN.
-
#send_event(params = {}) ⇒ Types::SendEventResponse
Sends an event to a room.
-
#tag_resource(params = {}) ⇒ Struct
Adds or updates tags for the AWS resource with the specified ARN.
-
#untag_resource(params = {}) ⇒ Struct
Removes tags from the resource with the specified ARN.
-
#update_logging_configuration(params = {}) ⇒ Types::UpdateLoggingConfigurationResponse
Updates a specified logging configuration.
-
#update_room(params = {}) ⇒ Types::UpdateRoomResponse
Updates a room’s configuration.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
Methods included from ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
446 447 448 |
# File 'gems/aws-sdk-ivschat/lib/aws-sdk-ivschat/client.rb', line 446 def initialize(*args) super end |
Instance Method Details
#create_chat_token(params = {}) ⇒ Types::CreateChatTokenResponse
Creates an encrypted token that is used by a chat participant to establish an individual WebSocket chat connection to a room. When the token is used to connect to chat, the connection is valid for the session duration specified in the request. The token becomes invalid at the token-expiration timestamp included in the response.
Use the capabilities
field to permit an end user to send messages or
moderate a room.
The attributes
field securely attaches structured data to the chat
session; the data is included within each message sent by the end user
and received by other participants in the room. Common use cases for
attributes include passing end-user profile data like an icon, display
name, colors, badges, and other display features.
Encryption keys are owned by Amazon IVS Chat and never used directly by your application.
520 521 522 523 |
# File 'gems/aws-sdk-ivschat/lib/aws-sdk-ivschat/client.rb', line 520 def create_chat_token(params = {}, = {}) req = build_request(:create_chat_token, params) req.send_request() end |
#create_logging_configuration(params = {}) ⇒ Types::CreateLoggingConfigurationResponse
Creates a logging configuration that allows clients to store and record sent messages.
598 599 600 601 |
# File 'gems/aws-sdk-ivschat/lib/aws-sdk-ivschat/client.rb', line 598 def create_logging_configuration(params = {}, = {}) req = build_request(:create_logging_configuration, params) req.send_request() end |
#create_room(params = {}) ⇒ Types::CreateRoomResponse
Creates a room that allows clients to connect and pass messages.
684 685 686 687 |
# File 'gems/aws-sdk-ivschat/lib/aws-sdk-ivschat/client.rb', line 684 def create_room(params = {}, = {}) req = build_request(:create_room, params) req.send_request() end |
#delete_logging_configuration(params = {}) ⇒ Struct
Deletes the specified logging configuration.
706 707 708 709 |
# File 'gems/aws-sdk-ivschat/lib/aws-sdk-ivschat/client.rb', line 706 def delete_logging_configuration(params = {}, = {}) req = build_request(:delete_logging_configuration, params) req.send_request() end |
#delete_message(params = {}) ⇒ Types::DeleteMessageResponse
Sends an event to a specific room which directs clients to delete a
specific message; that is, unrender it from view and delete it from
the client’s chat history. This event’s EventName
is
aws:DELETE_MESSAGE
. This replicates the DeleteMessage
WebSocket operation in the Amazon IVS Chat Messaging API.
757 758 759 760 |
# File 'gems/aws-sdk-ivschat/lib/aws-sdk-ivschat/client.rb', line 757 def (params = {}, = {}) req = build_request(:delete_message, params) req.send_request() end |
#delete_room(params = {}) ⇒ Struct
Deletes the specified room.
779 780 781 782 |
# File 'gems/aws-sdk-ivschat/lib/aws-sdk-ivschat/client.rb', line 779 def delete_room(params = {}, = {}) req = build_request(:delete_room, params) req.send_request() end |
#disconnect_user(params = {}) ⇒ Struct
Disconnects all connections using a specified user ID from a room. This replicates the DisconnectUser WebSocket operation in the Amazon IVS Chat Messaging API.
816 817 818 819 |
# File 'gems/aws-sdk-ivschat/lib/aws-sdk-ivschat/client.rb', line 816 def disconnect_user(params = {}, = {}) req = build_request(:disconnect_user, params) req.send_request() end |
#get_logging_configuration(params = {}) ⇒ Types::GetLoggingConfigurationResponse
Gets the specified logging configuration.
861 862 863 864 |
# File 'gems/aws-sdk-ivschat/lib/aws-sdk-ivschat/client.rb', line 861 def get_logging_configuration(params = {}, = {}) req = build_request(:get_logging_configuration, params) req.send_request() end |
#get_room(params = {}) ⇒ Types::GetRoomResponse
Gets the specified room.
911 912 913 914 |
# File 'gems/aws-sdk-ivschat/lib/aws-sdk-ivschat/client.rb', line 911 def get_room(params = {}, = {}) req = build_request(:get_room, params) req.send_request() end |
#list_logging_configurations(params = {}) ⇒ Types::ListLoggingConfigurationsResponse
Gets summary information about all your logging configurations in the AWS region where the API request is processed.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
960 961 962 963 |
# File 'gems/aws-sdk-ivschat/lib/aws-sdk-ivschat/client.rb', line 960 def list_logging_configurations(params = {}, = {}) req = build_request(:list_logging_configurations, params) req.send_request() end |
#list_rooms(params = {}) ⇒ Types::ListRoomsResponse
Gets summary information about all your rooms in the AWS region where
the API request is processed. Results are sorted in descending order
of updateTime
.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1022 1023 1024 1025 |
# File 'gems/aws-sdk-ivschat/lib/aws-sdk-ivschat/client.rb', line 1022 def list_rooms(params = {}, = {}) req = build_request(:list_rooms, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Gets information about AWS tags for the specified ARN.
1051 1052 1053 1054 |
# File 'gems/aws-sdk-ivschat/lib/aws-sdk-ivschat/client.rb', line 1051 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#send_event(params = {}) ⇒ Types::SendEventResponse
Sends an event to a room. Use this within your application’s business logic to send events to clients of a room; e.g., to notify clients to change the way the chat UI is rendered.
1093 1094 1095 1096 |
# File 'gems/aws-sdk-ivschat/lib/aws-sdk-ivschat/client.rb', line 1093 def send_event(params = {}, = {}) req = build_request(:send_event, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
Adds or updates tags for the AWS resource with the specified ARN.
1130 1131 1132 1133 |
# File 'gems/aws-sdk-ivschat/lib/aws-sdk-ivschat/client.rb', line 1130 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Removes tags from the resource with the specified ARN.
1165 1166 1167 1168 |
# File 'gems/aws-sdk-ivschat/lib/aws-sdk-ivschat/client.rb', line 1165 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_logging_configuration(params = {}) ⇒ Types::UpdateLoggingConfigurationResponse
Updates a specified logging configuration.
1231 1232 1233 1234 |
# File 'gems/aws-sdk-ivschat/lib/aws-sdk-ivschat/client.rb', line 1231 def update_logging_configuration(params = {}, = {}) req = build_request(:update_logging_configuration, params) req.send_request() end |
#update_room(params = {}) ⇒ Types::UpdateRoomResponse
Updates a room’s configuration.
1308 1309 1310 1311 |
# File 'gems/aws-sdk-ivschat/lib/aws-sdk-ivschat/client.rb', line 1308 def update_room(params = {}, = {}) req = build_request(:update_room, params) req.send_request() end |