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.
409 410 411 |
# File 'gems/aws-sdk-ivschat/lib/aws-sdk-ivschat/client.rb', line 409 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.
483 484 485 486 |
# File 'gems/aws-sdk-ivschat/lib/aws-sdk-ivschat/client.rb', line 483 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.
560 561 562 563 |
# File 'gems/aws-sdk-ivschat/lib/aws-sdk-ivschat/client.rb', line 560 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.
645 646 647 648 |
# File 'gems/aws-sdk-ivschat/lib/aws-sdk-ivschat/client.rb', line 645 def create_room(params = {}, = {}) req = build_request(:create_room, params) req.send_request() end |
#delete_logging_configuration(params = {}) ⇒ Struct
Deletes the specified logging configuration.
667 668 669 670 |
# File 'gems/aws-sdk-ivschat/lib/aws-sdk-ivschat/client.rb', line 667 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.
718 719 720 721 |
# File 'gems/aws-sdk-ivschat/lib/aws-sdk-ivschat/client.rb', line 718 def (params = {}, = {}) req = build_request(:delete_message, params) req.send_request() end |
#delete_room(params = {}) ⇒ Struct
Deletes the specified room.
740 741 742 743 |
# File 'gems/aws-sdk-ivschat/lib/aws-sdk-ivschat/client.rb', line 740 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.
777 778 779 780 |
# File 'gems/aws-sdk-ivschat/lib/aws-sdk-ivschat/client.rb', line 777 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.
822 823 824 825 |
# File 'gems/aws-sdk-ivschat/lib/aws-sdk-ivschat/client.rb', line 822 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.
872 873 874 875 |
# File 'gems/aws-sdk-ivschat/lib/aws-sdk-ivschat/client.rb', line 872 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.
921 922 923 924 |
# File 'gems/aws-sdk-ivschat/lib/aws-sdk-ivschat/client.rb', line 921 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.
983 984 985 986 |
# File 'gems/aws-sdk-ivschat/lib/aws-sdk-ivschat/client.rb', line 983 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.
1012 1013 1014 1015 |
# File 'gems/aws-sdk-ivschat/lib/aws-sdk-ivschat/client.rb', line 1012 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.
1054 1055 1056 1057 |
# File 'gems/aws-sdk-ivschat/lib/aws-sdk-ivschat/client.rb', line 1054 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.
1090 1091 1092 1093 |
# File 'gems/aws-sdk-ivschat/lib/aws-sdk-ivschat/client.rb', line 1090 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.
1124 1125 1126 1127 |
# File 'gems/aws-sdk-ivschat/lib/aws-sdk-ivschat/client.rb', line 1124 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.
1190 1191 1192 1193 |
# File 'gems/aws-sdk-ivschat/lib/aws-sdk-ivschat/client.rb', line 1190 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.
1267 1268 1269 1270 |
# File 'gems/aws-sdk-ivschat/lib/aws-sdk-ivschat/client.rb', line 1267 def update_room(params = {}, = {}) req = build_request(:update_room, params) req.send_request() end |