com.amazonaws.services.ivschat

Class AbstractAmazonivschat

java.lang.Object

com.amazonaws.services.ivschat.AbstractAmazonivschat

All Implemented Interfaces:

Amazonivschat

Direct Known Subclasses:

AbstractAmazonivschatAsync

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AbstractAmazonivschat
extends Object
implements Amazonivschat

Abstract implementation of Amazonivschat. Convenient method forms pass through to the corresponding overload that takes a request object, which throws an UnsupportedOperationException.

Field Summary

Fields inherited from interface com.amazonaws.services.ivschat.Amazonivschat

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
CreateChatTokenResult	createChatToken(CreateChatTokenRequest request) Creates an encrypted token that is used by a chat participant to establish an individual WebSocket chat connection to a room.
CreateLoggingConfigurationResult	createLoggingConfiguration(CreateLoggingConfigurationRequest request) Creates a logging configuration that allows clients to store and record sent messages.
CreateRoomResult	createRoom(CreateRoomRequest request) Creates a room that allows clients to connect and pass messages.
DeleteLoggingConfigurationResult	deleteLoggingConfiguration(DeleteLoggingConfigurationRequest request) Deletes the specified logging configuration.
DeleteMessageResult	deleteMessage(DeleteMessageRequest request) 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.
DeleteRoomResult	deleteRoom(DeleteRoomRequest request) Deletes the specified room.
DisconnectUserResult	disconnectUser(DisconnectUserRequest request) Disconnects all connections using a specified user ID from a room.
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
GetLoggingConfigurationResult	getLoggingConfiguration(GetLoggingConfigurationRequest request) Gets the specified logging configuration.
GetRoomResult	getRoom(GetRoomRequest request) Gets the specified room.
ListLoggingConfigurationsResult	listLoggingConfigurations(ListLoggingConfigurationsRequest request) Gets summary information about all your logging configurations in the AWS region where the API request is processed.
ListRoomsResult	listRooms(ListRoomsRequest request) Gets summary information about all your rooms in the AWS region where the API request is processed.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest request) Gets information about AWS tags for the specified ARN.
SendEventResult	sendEvent(SendEventRequest request) Sends an event to a room.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
TagResourceResult	tagResource(TagResourceRequest request) Adds or updates tags for the AWS resource with the specified ARN.
UntagResourceResult	untagResource(UntagResourceRequest request) Removes tags from the resource with the specified ARN.
UpdateLoggingConfigurationResult	updateLoggingConfiguration(UpdateLoggingConfigurationRequest request) Updates a specified logging configuration.
UpdateRoomResult	updateRoom(UpdateRoomRequest request) Updates a room’s configuration.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

createChatToken

public CreateChatTokenResult createChatToken(CreateChatTokenRequest request)

Description copied from interface: Amazonivschat

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.

Specified by:

createChatToken in interface Amazonivschat

Returns:

Result of the CreateChatToken operation returned by the service.

See Also:

AWS API Documentation

createLoggingConfiguration

public CreateLoggingConfigurationResult createLoggingConfiguration(CreateLoggingConfigurationRequest request)

Description copied from interface: Amazonivschat

Creates a logging configuration that allows clients to store and record sent messages.

Specified by:

createLoggingConfiguration in interface Amazonivschat

Returns:

Result of the CreateLoggingConfiguration operation returned by the service.

See Also:

AWS API Documentation

createRoom

public CreateRoomResult createRoom(CreateRoomRequest request)

Description copied from interface: Amazonivschat

Creates a room that allows clients to connect and pass messages.

Specified by:

createRoom in interface Amazonivschat

Returns:

Result of the CreateRoom operation returned by the service.

See Also:

AWS API Documentation

deleteLoggingConfiguration

public DeleteLoggingConfigurationResult deleteLoggingConfiguration(DeleteLoggingConfigurationRequest request)

Description copied from interface: Amazonivschat

Deletes the specified logging configuration.

Specified by:

deleteLoggingConfiguration in interface Amazonivschat

Returns:

Result of the DeleteLoggingConfiguration operation returned by the service.

See Also:

AWS API Documentation

deleteMessage

public DeleteMessageResult deleteMessage(DeleteMessageRequest request)

Description copied from interface: Amazonivschat

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.

Specified by:

deleteMessage in interface Amazonivschat

Returns:

Result of the DeleteMessage operation returned by the service.

See Also:

AWS API Documentation

deleteRoom

public DeleteRoomResult deleteRoom(DeleteRoomRequest request)

Description copied from interface: Amazonivschat

Deletes the specified room.

Specified by:

deleteRoom in interface Amazonivschat

Returns:

Result of the DeleteRoom operation returned by the service.

See Also:

AWS API Documentation

disconnectUser

public DisconnectUserResult disconnectUser(DisconnectUserRequest request)

Description copied from interface: Amazonivschat

Disconnects all connections using a specified user ID from a room. This replicates the DisconnectUser WebSocket operation in the Amazon IVS Chat Messaging API.

Specified by:

disconnectUser in interface Amazonivschat

Returns:

Result of the DisconnectUser operation returned by the service.

See Also:

AWS API Documentation

getLoggingConfiguration

public GetLoggingConfigurationResult getLoggingConfiguration(GetLoggingConfigurationRequest request)

Description copied from interface: Amazonivschat

Gets the specified logging configuration.

Specified by:

getLoggingConfiguration in interface Amazonivschat

Returns:

Result of the GetLoggingConfiguration operation returned by the service.

See Also:

AWS API Documentation

getRoom

public GetRoomResult getRoom(GetRoomRequest request)

Description copied from interface: Amazonivschat

Gets the specified room.

Specified by:

getRoom in interface Amazonivschat

Returns:

Result of the GetRoom operation returned by the service.

See Also:

AWS API Documentation

listLoggingConfigurations

public ListLoggingConfigurationsResult listLoggingConfigurations(ListLoggingConfigurationsRequest request)

Description copied from interface: Amazonivschat

Gets summary information about all your logging configurations in the AWS region where the API request is processed.

Specified by:

listLoggingConfigurations in interface Amazonivschat

Returns:

Result of the ListLoggingConfigurations operation returned by the service.

See Also:

AWS API Documentation

listRooms

public ListRoomsResult listRooms(ListRoomsRequest request)

Description copied from interface: Amazonivschat

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.

Specified by:

listRooms in interface Amazonivschat

Returns:

Result of the ListRooms operation returned by the service.

See Also:

AWS API Documentation

listTagsForResource

public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)

Description copied from interface: Amazonivschat

Gets information about AWS tags for the specified ARN.

Specified by:

listTagsForResource in interface Amazonivschat

Returns:

Result of the ListTagsForResource operation returned by the service.

See Also:

AWS API Documentation

sendEvent

public SendEventResult sendEvent(SendEventRequest request)

Description copied from interface: Amazonivschat

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.

Specified by:

sendEvent in interface Amazonivschat

Returns:

Result of the SendEvent operation returned by the service.

See Also:

AWS API Documentation

tagResource

public TagResourceResult tagResource(TagResourceRequest request)

Description copied from interface: Amazonivschat

Adds or updates tags for the AWS resource with the specified ARN.

Specified by:

tagResource in interface Amazonivschat

Returns:

Result of the TagResource operation returned by the service.

See Also:

AWS API Documentation

untagResource

public UntagResourceResult untagResource(UntagResourceRequest request)

Description copied from interface: Amazonivschat

Removes tags from the resource with the specified ARN.

Specified by:

untagResource in interface Amazonivschat

Returns:

Result of the UntagResource operation returned by the service.

See Also:

AWS API Documentation

updateLoggingConfiguration

public UpdateLoggingConfigurationResult updateLoggingConfiguration(UpdateLoggingConfigurationRequest request)

Description copied from interface: Amazonivschat

Updates a specified logging configuration.

Specified by:

updateLoggingConfiguration in interface Amazonivschat

Returns:

Result of the UpdateLoggingConfiguration operation returned by the service.

See Also:

AWS API Documentation

updateRoom

public UpdateRoomResult updateRoom(UpdateRoomRequest request)

Description copied from interface: Amazonivschat

Updates a room’s configuration.

Specified by:

updateRoom in interface Amazonivschat

Returns:

Result of the UpdateRoom operation returned by the service.

See Also:

AWS API Documentation

shutdown

public void shutdown()

Description copied from interface: Amazonivschat

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

Specified by:

shutdown in interface Amazonivschat

getCachedResponseMetadata

public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Description copied from interface: Amazonivschat

Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.

Specified by:

getCachedResponseMetadata in interface Amazonivschat

Parameters:

request - The originally executed request.

Returns:

The response metadata for the specified request, or null if none is available.