Google Cloud Ces V1 Client - Class SecuritySettings (0.1.0)

Reference documentation and code samples for the Google Cloud Ces V1 Client class SecuritySettings.

Security settings for the web widget.

Generated from protobuf message google.cloud.ces.v1.ChannelProfile.WebWidgetConfig.SecuritySettings

Namespace

Google \ Cloud \ Ces \ V1 \ ChannelProfile \ WebWidgetConfig

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ enable_public_access`	`bool` 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.
`↳ enable_origin_check`	`bool` 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.
`↳ allowed_origins`	`array` 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"
`↳ enable_recaptcha`	`bool` Optional. Indicates whether reCAPTCHA verification for the web widget is enabled.

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.

Returns
Type	Description
`bool`

setEnablePublicAccess

Optional. Indicates whether public access to the web widget is enabled.

Parameter
Name	Description
`var`	`bool`

Returns
Type	Description
`$this`

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.

Returns
Type	Description
`bool`

setEnableOriginCheck

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.

Parameter
Name	Description
`var`	`bool`

Returns
Type	Description
`$this`

getAllowedOrigins

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"

Returns
Type	Description
`Google\Protobuf\Internal\RepeatedField`

setAllowedOrigins