Reference documentation and code samples for the Google Shopping Merchant Issue Resolution V1 Client class TextInput.
Text input allows the business to provide a text value.
Generated from protobuf message google.shopping.merchant.issueresolution.v1.InputField.TextInput
Namespace
Google \ Shopping \ Merchant \ IssueResolution \ V1 \ InputFieldMethods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ type |
int
Type of the text input |
↳ additional_info |
Google\Shopping\Merchant\IssueResolution\V1\TextWithTooltip
Additional info regarding the field to be displayed to the business. For example, warning to not include personal identifiable information. There may be more information to be shown in a tooltip. |
↳ format_info |
string
Information about the required format. If present, it should be shown close to the input field to help the business to provide a correct value. For example: "VAT numbers should be in a format similar to SK9999999999" |
↳ aria_label |
string
Text to be used as the aria-label for the input. |
getType
Type of the text input
| Returns | |
|---|---|
| Type | Description |
int |
|
setType
Type of the text input
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getAdditionalInfo
Additional info regarding the field to be displayed to the business. For example, warning to not include personal identifiable information. There may be more information to be shown in a tooltip.
| Returns | |
|---|---|
| Type | Description |
Google\Shopping\Merchant\IssueResolution\V1\TextWithTooltip|null |
|
hasAdditionalInfo
clearAdditionalInfo
setAdditionalInfo
Additional info regarding the field to be displayed to the business. For example, warning to not include personal identifiable information. There may be more information to be shown in a tooltip.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Shopping\Merchant\IssueResolution\V1\TextWithTooltip
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getFormatInfo
Information about the required format. If present, it should be shown close to the input field to help the business to provide a correct value.
For example: "VAT numbers should be in a format similar to SK9999999999"
| Returns | |
|---|---|
| Type | Description |
string |
|
hasFormatInfo
clearFormatInfo
setFormatInfo
Information about the required format. If present, it should be shown close to the input field to help the business to provide a correct value.
For example: "VAT numbers should be in a format similar to SK9999999999"
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getAriaLabel
Text to be used as the aria-label for the input.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasAriaLabel
clearAriaLabel
setAriaLabel
Text to be used as the aria-label for the input.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|