Reference documentation and code samples for the Google Apps Chat V1 Client class PositionSectionRequest.
Request message for positioning a section.
Generated from protobuf message google.chat.v1.PositionSectionRequest
Namespace
Google \ Apps \ Chat \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Required. The resource name of the section to position. Format: |
↳ sort_order |
int
Optional. The absolute position of the section in the list of sections. The position must be greater than 0. If the position is greater than the number of sections, the section will be appended to the end of the list. This operation inserts the section at the given position and shifts the original section at that position, and those below it, to the next position. |
↳ relative_position |
int
Optional. The relative position of the section in the list of sections. |
getName
Required. The resource name of the section to position.
Format: users/{user}/sections/{section}
| Returns | |
|---|---|
| Type | Description |
string |
|
setName
Required. The resource name of the section to position.
Format: users/{user}/sections/{section}
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSortOrder
Optional. The absolute position of the section in the list of sections.
The position must be greater than 0. If the position is greater than the number of sections, the section will be appended to the end of the list. This operation inserts the section at the given position and shifts the original section at that position, and those below it, to the next position.
| Returns | |
|---|---|
| Type | Description |
int |
|
hasSortOrder
setSortOrder
Optional. The absolute position of the section in the list of sections.
The position must be greater than 0. If the position is greater than the number of sections, the section will be appended to the end of the list. This operation inserts the section at the given position and shifts the original section at that position, and those below it, to the next position.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getRelativePosition
Optional. The relative position of the section in the list of sections.
| Returns | |
|---|---|
| Type | Description |
int |
Enum of type Position. |
hasRelativePosition
setRelativePosition
Optional. The relative position of the section in the list of sections.
| Parameter | |
|---|---|
| Name | Description |
var |
int
Enum of type Position. |
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPosition
| Returns | |
|---|---|
| Type | Description |
string |
|