GETSIGNALINGCHANNELENDPOINT()`¶

About GetSignalingChannelEndpoint¶

Provides an endpoint for the specified signaling channel to send and receive messages. This API uses the SingleMasterChannelEndpointConfiguration input parameter, which consists of the Protocols and Role properties.

Protocols is used to determine the communication mechanism. For example, if you specify WSS as the protocol, this API produces a secure websocket endpoint. If you specify HTTPS as the protocol, this API generates an HTTPS endpoint. If you specify WEBRTC as the protocol, but the signaling channel isn't configured for ingestion, you will receive the error InvalidArgumentException.

Role determines the messaging permissions. A MASTER role results in this API generating an endpoint that a client can use to communicate with any of the viewers on the channel. A VIEWER role results in this API generating an endpoint that a client can use to communicate only with a MASTER.

Method Signature¶

METHODS /AWS1/IF_KNV~GETSIGNALINGCHANNELENDPOINT
  IMPORTING
    !IV_CHANNELARN TYPE /AWS1/KNVRESOURCEARN OPTIONAL
    !IO_SINGLEMASTERCHANNELENDP00 TYPE REF TO /AWS1/CL_KNVSINGLEMASTERCHAN00 OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_knvgetsignalingchan01
  RAISING
    /AWS1/CX_KNVACCESSDENIEDEX
    /AWS1/CX_KNVCLIENTLIMITEXCDEX
    /AWS1/CX_KNVINVALIDARGUMENTEX
    /AWS1/CX_KNVRESOURCEINUSEEX
    /AWS1/CX_KNVRESOURCENOTFOUNDEX
    /AWS1/CX_KNVCLIENTEXC
    /AWS1/CX_KNVSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_channelarn` `TYPE /AWS1/KNVRESOURCEARN` `/AWS1/KNVRESOURCEARN`¶

The Amazon Resource Name (ARN) of the signalling channel for which you want to get an endpoint.

Optional arguments:¶

`io_singlemasterchannelendp00` `TYPE REF TO /AWS1/CL_KNVSINGLEMASTERCHAN00` `/AWS1/CL_KNVSINGLEMASTERCHAN00`¶

A structure containing the endpoint configuration for the SINGLE_MASTER channel type.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_knvgetsignalingchan01` `/AWS1/CL_KNVGETSIGNALINGCHAN01`¶

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->getsignalingchannelendpoint(
  io_singlemasterchannelendp00 = new /aws1/cl_knvsinglemasterchan00(
    it_protocols = VALUE /aws1/cl_knvlistofprotocols_w=>tt_listofprotocols(
      ( new /aws1/cl_knvlistofprotocols_w( |string| ) )
    )
    iv_role = |string|
  )
  iv_channelarn = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  LOOP AT lo_result->get_resourceendpointlist( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_channelprotocol = lo_row_1->get_protocol( ).
      lv_resourceendpoint = lo_row_1->get_resourceendpoint( ).
    ENDIF.
  ENDLOOP.
ENDIF.

/AWS1/IF_KNV=>GETSIGNALINGCHANNELENDPOINT()¶