CREATEATTENDEE()`¶

About CreateAttendee¶

Creates a new attendee for an active Amazon Chime SDK meeting. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide.

Method Signature¶

METHODS /AWS1/IF_CHM~CREATEATTENDEE
  IMPORTING
    !IV_MEETINGID TYPE /AWS1/CHMGUIDSTRING OPTIONAL
    !IV_EXTERNALUSERID TYPE /AWS1/CHMEXTERNALUSERID OPTIONAL
    !IO_CAPABILITIES TYPE REF TO /AWS1/CL_CHMATTENDEECAPABILI00 OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_chmcreateattendeersp
  RAISING
    /AWS1/CX_CHMBADREQUESTEX
    /AWS1/CX_CHMFORBIDDENEXCEPTION
    /AWS1/CX_CHMLIMITEXCEEDEDEX
    /AWS1/CX_CHMNOTFOUNDEXCEPTION
    /AWS1/CX_CHMSERVICEFAILUREEX
    /AWS1/CX_CHMSERVICEUNAVAILEX
    /AWS1/CX_CHMTHROTTLINGEX
    /AWS1/CX_CHMUNAUTHORIZEDEX
    /AWS1/CX_CHMUNPROCABLEENTITYEX
    /AWS1/CX_CHMCLIENTEXC
    /AWS1/CX_CHMSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_meetingid` `TYPE /AWS1/CHMGUIDSTRING` `/AWS1/CHMGUIDSTRING`¶

The unique ID of the meeting.

`iv_externaluserid` `TYPE /AWS1/CHMEXTERNALUSERID` `/AWS1/CHMEXTERNALUSERID`¶

The Amazon Chime SDK external user ID. An idempotency token. Links the attendee to an identity managed by a builder application.

Pattern: [-_&@+=,(){}[]\/«».:|'"#a-zA-Z0-9À-ÿ\s]*

Values that begin with aws: are reserved. You can't configure a value that uses this prefix.

Optional arguments:¶

`io_capabilities` `TYPE REF TO /AWS1/CL_CHMATTENDEECAPABILI00` `/AWS1/CL_CHMATTENDEECAPABILI00`¶

The capabilities (audio, video, or content) that you want to grant an attendee. If you don't specify capabilities, all users have send and receive capabilities on all media channels by default.

You use the capabilities with a set of values that control what the capabilities can do, such as SendReceive data. For more information about those values, see .

When using capabilities, be aware of these corner cases:

If you specify MeetingFeatures:Video:MaxResolution:None when you create a meeting, all API requests that include SendReceive, Send, or Receive for AttendeeCapabilities:Video will be rejected with ValidationError 400.

If you specify MeetingFeatures:Content:MaxResolution:None when you create a meeting, all API requests that include SendReceive, Send, or Receive for AttendeeCapabilities:Content will be rejected with ValidationError 400.

You can't set content capabilities to SendReceive or Receive unless you also set video capabilities to SendReceive or Receive. If you don't set the video capability to receive, the response will contain an HTTP 400 Bad Request status code. However, you can set your video capability to receive and you set your content capability to not receive.

If meeting features is defined as Video:MaxResolution:None but Content:MaxResolution is defined as something other than None and attendee capabilities are not defined in the API request, then the default attendee video capability is set to Receive and attendee content capability is set to SendReceive. This is because content SendReceive requires video to be at least Receive.

When you change an audio capability from None or Receive to Send or SendReceive , and if the attendee left their microphone unmuted, audio will flow from the attendee to the other meeting participants.

When you change a video or content capability from None or Receive to Send or SendReceive , and if the attendee turned on their video or content streams, remote attendees can receive those streams, but only after media renegotiation between the client and the Amazon Chime back-end server.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_chmcreateattendeersp` `/AWS1/CL_CHMCREATEATTENDEERSP`¶

Domain /AWS1/RT_ACCOUNT_ID

Primitive Type NUMC

Examples¶

Syntax Example¶

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

DATA(lo_result) = lo_client->createattendee(
  io_capabilities = new /aws1/cl_chmattendeecapabili00(
    iv_audio = |string|
    iv_content = |string|
    iv_video = |string|
  )
  iv_externaluserid = |string|
  iv_meetingid = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lo_attendee = lo_result->get_attendee( ).
  IF lo_attendee IS NOT INITIAL.
    lv_externaluserid = lo_attendee->get_externaluserid( ).
    lv_guidstring = lo_attendee->get_attendeeid( ).
    lv_jointokenstring = lo_attendee->get_jointoken( ).
    lo_attendeecapabilities = lo_attendee->get_capabilities( ).
    IF lo_attendeecapabilities IS NOT INITIAL.
      lv_mediacapabilities = lo_attendeecapabilities->get_audio( ).
      lv_mediacapabilities = lo_attendeecapabilities->get_video( ).
      lv_mediacapabilities = lo_attendeecapabilities->get_content( ).
    ENDIF.
  ENDIF.
ENDIF.

/AWS1/IF_CHM=>CREATEATTENDEE()¶