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.
385 386 387 |
# File 'gems/aws-sdk-ivschat/lib/aws-sdk-ivschat/client.rb', line 385 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.
459 460 461 462 |
# File 'gems/aws-sdk-ivschat/lib/aws-sdk-ivschat/client.rb', line 459 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.
536 537 538 539 |
# File 'gems/aws-sdk-ivschat/lib/aws-sdk-ivschat/client.rb', line 536 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.
621 622 623 624 |
# File 'gems/aws-sdk-ivschat/lib/aws-sdk-ivschat/client.rb', line 621 def create_room(params = {}, = {}) req = build_request(:create_room, params) req.send_request() end |
#delete_logging_configuration(params = {}) ⇒ Struct
Deletes the specified logging configuration.
643 644 645 646 |
# File 'gems/aws-sdk-ivschat/lib/aws-sdk-ivschat/client.rb', line 643 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.
694 695 696 697 |
# File 'gems/aws-sdk-ivschat/lib/aws-sdk-ivschat/client.rb', line 694 def (params = {}, = {}) req = build_request(:delete_message, params) req.send_request() end |
#delete_room(params = {}) ⇒ Struct
Deletes the specified room.
716 717 718 719 |
# File 'gems/aws-sdk-ivschat/lib/aws-sdk-ivschat/client.rb', line 716 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.
753 754 755 756 |
# File 'gems/aws-sdk-ivschat/lib/aws-sdk-ivschat/client.rb', line 753 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.
798 799 800 801 |
# File 'gems/aws-sdk-ivschat/lib/aws-sdk-ivschat/client.rb', line 798 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.
848 849 850 851 |
# File 'gems/aws-sdk-ivschat/lib/aws-sdk-ivschat/client.rb', line 848 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.
897 898 899 900 |
# File 'gems/aws-sdk-ivschat/lib/aws-sdk-ivschat/client.rb', line 897 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.
959 960 961 962 |
# File 'gems/aws-sdk-ivschat/lib/aws-sdk-ivschat/client.rb', line 959 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.
988 989 990 991 |
# File 'gems/aws-sdk-ivschat/lib/aws-sdk-ivschat/client.rb', line 988 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.
1030 1031 1032 1033 |
# File 'gems/aws-sdk-ivschat/lib/aws-sdk-ivschat/client.rb', line 1030 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.
1066 1067 1068 1069 |
# File 'gems/aws-sdk-ivschat/lib/aws-sdk-ivschat/client.rb', line 1066 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.
1100 1101 1102 1103 |
# File 'gems/aws-sdk-ivschat/lib/aws-sdk-ivschat/client.rb', line 1100 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.
1166 1167 1168 1169 |
# File 'gems/aws-sdk-ivschat/lib/aws-sdk-ivschat/client.rb', line 1166 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.
1243 1244 1245 1246 |
# File 'gems/aws-sdk-ivschat/lib/aws-sdk-ivschat/client.rb', line 1243 def update_room(params = {}, = {}) req = build_request(:update_room, params) req.send_request() end |