API for Amazon Chime SDK Messaging¶
ABAP Package | /AWS1/API_CHS |
---|---|
ABAP SDK "TLA" | CHS |
ABAP Interface | /AWS1/IF_CHS |
The "TLA" is a Three Letter Abbreviation that appears in ABAP class names, data dictionary
objects and other ABAP objects throughout the AWS SDK for SAP ABAP. The TLA for Amazon Chime SDK Messaging is CHS
.
This TLA helps squeeze ABAP objects into the 30-character length limit of the ABAP data dictionary.
Installation¶
To install the AWS SDK for SAP ABAP, import the Core transport, along with the transport for the Chime SDK Messaging module and other API modules you are interested in. A few modules are included in the Core transport itself. For more information, see the Developer Guide guide.
About The Service¶
The Amazon Chime SDK Messaging APIs in this section allow software developers to send and receive messages in custom messaging applications. These APIs depend on the frameworks provided by the Amazon Chime SDK Identity APIs. For more information about the messaging APIs, see Amazon Chime SDK messaging.
Using the SDK¶
In your code, create a client using the SDK module for Amazon Chime SDK Messaging, which is created with
factory method /AWS1/CL_CHS_FACTORY
=>CREATE()
.
In this example we will assume you have configured
an SDK profile in transaction /AWS1/IMG
called ZFINANCE
.
DATA(go_session) = /aws1/cl_rt_session_aws=>create( 'ZFINANCE' ).
DATA(go_chs) = /aws1/cl_chs_factory=>create( go_session ).
Your variable go_chs
is an instance of /AWS1/IF_CHS
,
and all of the operations
in the Amazon Chime SDK Messaging service are accessed by calling methods in /AWS1/IF_CHS
.
API Operations¶
For an overview of ABAP method calls corresponding to API operations in Amazon Chime SDK Messaging, see the Operation List.
Factory Method¶
/AWS1/CL_CHS_FACTORY=>CREATE( )
¶
Creates an object of type /AWS1/IF_CHS
.
IMPORTING¶
Required arguments:¶
IO_SESSION
TYPE REF TO
/AWS1/CL_RT_SESSION_BASE
¶
Optional arguments:¶
IV_PROTOCOL
TYPE
/AWS1/RT_PROTOCOL
¶
IV_REGION
TYPE
/AWS1/RT_REGION_ID
¶
IV_CUSTOM_ENDPOINT
TYPE
/AWS1/RT_ENDPOINT
¶
RETURNING¶
OO_CLIENT
TYPE REF TO
/AWS1/IF_CHS
¶
/AWS1/IF_CHS
represents the ABAP client for the Chime SDK Messaging service, representing each operation as a method call. For more information see the API Page page.