Google Chat V1 API - Class Google::Apps::Chat::V1::PositionSectionRequest (v0.22.0)

Reference documentation and code samples for the Google Chat V1 API class Google::Apps::Chat::V1::PositionSectionRequest.

Request message for positioning a section.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#name

def name() -> ::String
Returns
  • (::String) — Required. The resource name of the section to position.

    Format: users/{user}/sections/{section}

#name=

def name=(value) -> ::String
Parameter
  • value (::String) — Required. The resource name of the section to position.

    Format: users/{user}/sections/{section}

Returns
  • (::String) — Required. The resource name of the section to position.

    Format: users/{user}/sections/{section}

#relative_position

def relative_position() -> ::Google::Apps::Chat::V1::PositionSectionRequest::Position
Returns
  • (::Google::Apps::Chat::V1::PositionSectionRequest::Position) — Optional. The relative position of the section in the list of sections.

    Note: The following fields are mutually exclusive: relative_position, sort_order. If a field in that set is populated, all other fields in the set will automatically be cleared.

#relative_position=

def relative_position=(value) -> ::Google::Apps::Chat::V1::PositionSectionRequest::Position
Parameter
  • value (::Google::Apps::Chat::V1::PositionSectionRequest::Position) — Optional. The relative position of the section in the list of sections.

    Note: The following fields are mutually exclusive: relative_position, sort_order. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Google::Apps::Chat::V1::PositionSectionRequest::Position) — Optional. The relative position of the section in the list of sections.

    Note: The following fields are mutually exclusive: relative_position, sort_order. If a field in that set is populated, all other fields in the set will automatically be cleared.

#sort_order

def sort_order() -> ::Integer
Returns
  • (::Integer) — 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.

    Note: The following fields are mutually exclusive: sort_order, relative_position. If a field in that set is populated, all other fields in the set will automatically be cleared.

#sort_order=

def sort_order=(value) -> ::Integer
Parameter
  • value (::Integer) — 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.

    Note: The following fields are mutually exclusive: sort_order, relative_position. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Integer) — 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.

    Note: The following fields are mutually exclusive: sort_order, relative_position. If a field in that set is populated, all other fields in the set will automatically be cleared.