GETUICUSTOMIZATION()`¶

About GetUICustomization¶

Given a user pool ID or app client, returns information about classic hosted UI branding that you applied, if any. Returns user-pool level branding information if no app client branding is applied, or if you don't specify an app client ID. Returns an empty object if you haven't applied hosted UI branding to either the client or the user pool. For more information, see Hosted UI (classic) branding.

Method Signature¶

METHODS /AWS1/IF_CGP~GETUICUSTOMIZATION
  IMPORTING
    !IV_USERPOOLID TYPE /AWS1/CGPUSERPOOLIDTYPE OPTIONAL
    !IV_CLIENTID TYPE /AWS1/CGPCLIENTIDTYPE OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_cgpgetuicustization01
  RAISING
    /AWS1/CX_CGPINTERNALERROREX
    /AWS1/CX_CGPINVALIDPARAMETEREX
    /AWS1/CX_CGPNOTAUTHORIZEDEX
    /AWS1/CX_CGPRESOURCENOTFOUNDEX
    /AWS1/CX_CGPTOOMANYREQUESTSEX
    /AWS1/CX_CGPCLIENTEXC
    /AWS1/CX_CGPSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_userpoolid` `TYPE /AWS1/CGPUSERPOOLIDTYPE` `/AWS1/CGPUSERPOOLIDTYPE`¶

The ID of the user pool that you want to query for branding settings.

Optional arguments:¶

`iv_clientid` `TYPE /AWS1/CGPCLIENTIDTYPE` `/AWS1/CGPCLIENTIDTYPE`¶

The ID of the app client that you want to query for branding settings.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_cgpgetuicustization01` `/AWS1/CL_CGPGETUICUSTIZATION01`¶

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->getuicustomization(
  iv_clientid = |string|
  iv_userpoolid = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lo_uicustomizationtype = lo_result->get_uicustomization( ).
  IF lo_uicustomizationtype IS NOT INITIAL.
    lv_userpoolidtype = lo_uicustomizationtype->get_userpoolid( ).
    lv_clientidtype = lo_uicustomizationtype->get_clientid( ).
    lv_imageurltype = lo_uicustomizationtype->get_imageurl( ).
    lv_csstype = lo_uicustomizationtype->get_css( ).
    lv_cssversiontype = lo_uicustomizationtype->get_cssversion( ).
    lv_datetype = lo_uicustomizationtype->get_lastmodifieddate( ).
    lv_datetype = lo_uicustomizationtype->get_creationdate( ).
  ENDIF.
ENDIF.

/AWS1/IF_CGP=>GETUICUSTOMIZATION()¶