Interface ChannelProfile.WebWidgetConfig.SecuritySettingsOrBuilder (0.1.0)

public static interface ChannelProfile.WebWidgetConfig.SecuritySettingsOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAllowedOrigins(int index)

public abstract String getAllowedOrigins(int index)

Optional. The origins that are allowed to host the web widget. An origin is defined by RFC 6454. If empty, all origins are allowed. A maximum of 100 origins is allowed. Example: "https://example.com"

repeated string allowed_origins = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
index	int The index of the element to return.

Returns
Type	Description
String	The allowedOrigins at the given index.

getAllowedOriginsBytes(int index)

public abstract ByteString getAllowedOriginsBytes(int index)

Optional. The origins that are allowed to host the web widget. An origin is defined by RFC 6454. If empty, all origins are allowed. A maximum of 100 origins is allowed. Example: "https://example.com"

repeated string allowed_origins = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
index	int The index of the value to return.

Returns
Type	Description
ByteString	The bytes of the allowedOrigins at the given index.

getAllowedOriginsCount()

public abstract int getAllowedOriginsCount()

Optional. The origins that are allowed to host the web widget. An origin is defined by RFC 6454. If empty, all origins are allowed. A maximum of 100 origins is allowed. Example: "https://example.com"

repeated string allowed_origins = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int	The count of allowedOrigins.

getAllowedOriginsList()

public abstract List<String> getAllowedOriginsList()

Optional. The origins that are allowed to host the web widget. An origin is defined by RFC 6454. If empty, all origins are allowed. A maximum of 100 origins is allowed. Example: "https://example.com"

repeated string allowed_origins = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
List<String>	A list containing the allowedOrigins.

getEnableOriginCheck()

public abstract boolean getEnableOriginCheck()

Optional. Indicates whether origin check for the web widget is enabled. If true, the web widget will check the origin of the website that loads the web widget and only allow it to be loaded in the same origin or any of the allowed origins.

bool enable_origin_check = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	The enableOriginCheck.

getEnablePublicAccess()

public abstract boolean getEnablePublicAccess()

Optional. Indicates whether public access to the web widget is enabled. If true, the web widget will be publicly accessible. If false, the web widget must be integrated with your own authentication and authorization system to return valid credentials for accessing the CES agent.

bool enable_public_access = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	The enablePublicAccess.

getEnableRecaptcha()

public abstract boolean getEnableRecaptcha()

Optional. Indicates whether reCAPTCHA verification for the web widget is enabled.

bool enable_recaptcha = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	The enableRecaptcha.