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

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

Represents a section in Google Chat. Sections help users organize their spaces. There are two types of sections:

  1. System Sections: These are predefined sections managed by Google Chat. Their resource names are fixed, and they cannot be created, deleted, or have their display_name modified. Examples include:

    • users/{user}/sections/default-direct-messages
    • users/{user}/sections/default-spaces
    • users/{user}/sections/default-apps

  2. Custom Sections: These are sections created and managed by the user. Creating a custom section using CreateSection requires a display_name. Custom sections can be updated using UpdateSection and deleted using DeleteSection.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#display_name

def display_name() -> ::String
Returns
  • (::String) — Optional. The section's display name. Only populated for sections of type CUSTOM_SECTION. Supports up to 80 characters. Required when creating a CUSTOM_SECTION.

#display_name=

def display_name=(value) -> ::String
Parameter
  • value (::String) — Optional. The section's display name. Only populated for sections of type CUSTOM_SECTION. Supports up to 80 characters. Required when creating a CUSTOM_SECTION.
Returns
  • (::String) — Optional. The section's display name. Only populated for sections of type CUSTOM_SECTION. Supports up to 80 characters. Required when creating a CUSTOM_SECTION.

#name

def name() -> ::String
Returns
  • (::String) — Identifier. Resource name of the section.

    For system sections, the section ID is a constant string:

    • DEFAULT_DIRECT_MESSAGES: users/{user}/sections/default-direct-messages
    • DEFAULT_SPACES: users/{user}/sections/default-spaces
    • DEFAULT_APPS: users/{user}/sections/default-apps

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

#name=

def name=(value) -> ::String
Parameter
  • value (::String) — Identifier. Resource name of the section.

    For system sections, the section ID is a constant string:

    • DEFAULT_DIRECT_MESSAGES: users/{user}/sections/default-direct-messages
    • DEFAULT_SPACES: users/{user}/sections/default-spaces
    • DEFAULT_APPS: users/{user}/sections/default-apps

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

Returns
  • (::String) — Identifier. Resource name of the section.

    For system sections, the section ID is a constant string:

    • DEFAULT_DIRECT_MESSAGES: users/{user}/sections/default-direct-messages
    • DEFAULT_SPACES: users/{user}/sections/default-spaces
    • DEFAULT_APPS: users/{user}/sections/default-apps

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

#sort_order

def sort_order() -> ::Integer
Returns
  • (::Integer) — Output only. The order of the section in relation to other sections. Sections with a lower sort_order value appear before sections with a higher value.

#sort_order=

def sort_order=(value) -> ::Integer
Parameter
  • value (::Integer) — Output only. The order of the section in relation to other sections. Sections with a lower sort_order value appear before sections with a higher value.
Returns
  • (::Integer) — Output only. The order of the section in relation to other sections. Sections with a lower sort_order value appear before sections with a higher value.

#type

def type() -> ::Google::Apps::Chat::V1::Section::SectionType
Returns

#type=

def type=(value) -> ::Google::Apps::Chat::V1::Section::SectionType
Parameter
Returns