Skip to content

/AWS1/IF_WSW=>CREATEUSERSETTINGS()

About CreateUserSettings

Creates a user settings resource that can be associated with a web portal. Once associated with a web portal, user settings control how users can transfer data between a streaming session and the their local devices.

Method Signature

METHODS /AWS1/IF_WSW~CREATEUSERSETTINGS
  IMPORTING
    !IV_COPYALLOWED TYPE /AWS1/WSWENABLEDTYPE OPTIONAL
    !IV_PASTEALLOWED TYPE /AWS1/WSWENABLEDTYPE OPTIONAL
    !IV_DOWNLOADALLOWED TYPE /AWS1/WSWENABLEDTYPE OPTIONAL
    !IV_UPLOADALLOWED TYPE /AWS1/WSWENABLEDTYPE OPTIONAL
    !IV_PRINTALLOWED TYPE /AWS1/WSWENABLEDTYPE OPTIONAL
    !IT_TAGS TYPE /AWS1/CL_WSWTAG=>TT_TAGLIST OPTIONAL
    !IV_DISCNCTTIMEOUTINMINUTES TYPE /AWS1/WSWDISCNCTTMOUTINMINUTES OPTIONAL
    !IV_IDLEDISCNCTTMOUTINMINUTES TYPE /AWS1/WSWIDLEDISCNCTTOINMINS OPTIONAL
    !IV_CLIENTTOKEN TYPE /AWS1/WSWCLIENTTOKEN OPTIONAL
    !IO_COOKIESYNCHRONIZATIONCONF TYPE REF TO /AWS1/CL_WSWCOOKIESYNCHRONIZ00 OPTIONAL
    !IV_CUSTOMERMANAGEDKEY TYPE /AWS1/WSWKEYARN OPTIONAL
    !IT_ADDITIONALENCCONTEXT TYPE /AWS1/CL_WSWENCCONTEXTMAP_W=>TT_ENCRYPTIONCONTEXTMAP OPTIONAL
    !IV_DEEPLINKALLOWED TYPE /AWS1/WSWENABLEDTYPE OPTIONAL
    !IO_TOOLBARCONFIGURATION TYPE REF TO /AWS1/CL_WSWTOOLBARCONF OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_wswcreateuserstgsrsp
  RAISING
    /AWS1/CX_WSWACCESSDENIEDEX
    /AWS1/CX_WSWCONFLICTEXCEPTION
    /AWS1/CX_WSWINTERNALSERVEREX
    /AWS1/CX_WSWSERVICEQUOTAEXCDEX
    /AWS1/CX_WSWTHROTTLINGEX
    /AWS1/CX_WSWVALIDATIONEX
    /AWS1/CX_WSWCLIENTEXC
    /AWS1/CX_WSWSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_copyallowed TYPE /AWS1/WSWENABLEDTYPE /AWS1/WSWENABLEDTYPE

Specifies whether the user can copy text from the streaming session to the local device.

iv_pasteallowed TYPE /AWS1/WSWENABLEDTYPE /AWS1/WSWENABLEDTYPE

Specifies whether the user can paste text from the local device to the streaming session.

iv_downloadallowed TYPE /AWS1/WSWENABLEDTYPE /AWS1/WSWENABLEDTYPE

Specifies whether the user can download files from the streaming session to the local device.

iv_uploadallowed TYPE /AWS1/WSWENABLEDTYPE /AWS1/WSWENABLEDTYPE

Specifies whether the user can upload files from the local device to the streaming session.

iv_printallowed TYPE /AWS1/WSWENABLEDTYPE /AWS1/WSWENABLEDTYPE

Specifies whether the user can print to the local device.

Optional arguments:

it_tags TYPE /AWS1/CL_WSWTAG=>TT_TAGLIST TT_TAGLIST

The tags to add to the user settings resource. A tag is a key-value pair.

iv_discncttimeoutinminutes TYPE /AWS1/WSWDISCNCTTMOUTINMINUTES /AWS1/WSWDISCNCTTMOUTINMINUTES

The amount of time that a streaming session remains active after users disconnect.

iv_idlediscncttmoutinminutes TYPE /AWS1/WSWIDLEDISCNCTTOINMINS /AWS1/WSWIDLEDISCNCTTOINMINS

The amount of time that users can be idle (inactive) before they are disconnected from their streaming session and the disconnect timeout interval begins.

iv_clienttoken TYPE /AWS1/WSWCLIENTTOKEN /AWS1/WSWCLIENTTOKEN

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, subsequent retries with the same client token returns the result from the original successful request.

If you do not specify a client token, one is automatically generated by the Amazon Web Services SDK.

io_cookiesynchronizationconf TYPE REF TO /AWS1/CL_WSWCOOKIESYNCHRONIZ00 /AWS1/CL_WSWCOOKIESYNCHRONIZ00

The configuration that specifies which cookies should be synchronized from the end user's local browser to the remote browser.

iv_customermanagedkey TYPE /AWS1/WSWKEYARN /AWS1/WSWKEYARN

The customer managed key used to encrypt sensitive information in the user settings.

it_additionalenccontext TYPE /AWS1/CL_WSWENCCONTEXTMAP_W=>TT_ENCRYPTIONCONTEXTMAP TT_ENCRYPTIONCONTEXTMAP

The additional encryption context of the user settings.

iv_deeplinkallowed TYPE /AWS1/WSWENABLEDTYPE /AWS1/WSWENABLEDTYPE

Specifies whether the user can use deep links that open automatically when connecting to a session.

io_toolbarconfiguration TYPE REF TO /AWS1/CL_WSWTOOLBARCONF /AWS1/CL_WSWTOOLBARCONF

The configuration of the toolbar. This allows administrators to select the toolbar type and visual mode, set maximum display resolution for sessions, and choose which items are visible to end users during their sessions. If administrators do not modify these settings, end users retain control over their toolbar preferences.

RETURNING

oo_output TYPE REF TO /aws1/cl_wswcreateuserstgsrsp /AWS1/CL_WSWCREATEUSERSTGSRSP

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->createusersettings(
  io_cookiesynchronizationconf = new /aws1/cl_wswcookiesynchroniz00(
    it_allowlist = VALUE /aws1/cl_wswcookiespec=>tt_cookiespecifications(
      (
        new /aws1/cl_wswcookiespec(
          iv_domain = |string|
          iv_name = |string|
          iv_path = |string|
        )
      )
    )
    it_blocklist = VALUE /aws1/cl_wswcookiespec=>tt_cookiespecifications(
      (
        new /aws1/cl_wswcookiespec(
          iv_domain = |string|
          iv_name = |string|
          iv_path = |string|
        )
      )
    )
  )
  io_toolbarconfiguration = new /aws1/cl_wswtoolbarconf(
    it_hiddentoolbaritems = VALUE /aws1/cl_wswhiddentoolbarite00=>tt_hiddentoolbaritemlist(
      ( new /aws1/cl_wswhiddentoolbarite00( |string| ) )
    )
    iv_maxdisplayresolution = |string|
    iv_toolbartype = |string|
    iv_visualmode = |string|
  )
  it_additionalenccontext = VALUE /aws1/cl_wswenccontextmap_w=>tt_encryptioncontextmap(
    (
      VALUE /aws1/cl_wswenccontextmap_w=>ts_encryptioncontextmap_maprow(
        key = |string|
        value = new /aws1/cl_wswenccontextmap_w( |string| )
      )
    )
  )
  it_tags = VALUE /aws1/cl_wswtag=>tt_taglist(
    (
      new /aws1/cl_wswtag(
        iv_key = |string|
        iv_value = |string|
      )
    )
  )
  iv_clienttoken = |string|
  iv_copyallowed = |string|
  iv_customermanagedkey = |string|
  iv_deeplinkallowed = |string|
  iv_discncttimeoutinminutes = 123
  iv_downloadallowed = |string|
  iv_idlediscncttmoutinminutes = 123
  iv_pasteallowed = |string|
  iv_printallowed = |string|
  iv_uploadallowed = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_arn = lo_result->get_usersettingsarn( ).
ENDIF.