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:
-
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_namemodified. Examples include:-
users/{user}/sections/default-direct-messages -
users/{user}/sections/default-spaces -
users/{user}/sections/default-apps
-
-
Custom Sections:These are sections created and managed by the user. Creating a custom section using
CreateSectionrequiresadisplay_name. Custom sections can be updated usingUpdateSectionand deleted usingDeleteSection.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#display_name
def
display_name
()
-
>
::
String
- (::String) — Optional. The section's display name. Only populated for sections of type
CUSTOM_SECTION. Supports up to 80 characters. Required when creating aCUSTOM_SECTION.
#display_name=
def
display_name=
(
value
)
-
>
::
String
- value(::String) — Optional. The section's display name. Only populated for sections of type
CUSTOM_SECTION. Supports up to 80 characters. Required when creating aCUSTOM_SECTION.
- (::String) — Optional. The section's display name. Only populated for sections of type
CUSTOM_SECTION. Supports up to 80 characters. Required when creating aCUSTOM_SECTION.
#name
def
name
()
-
>
::
String
- (::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} - DEFAULT_DIRECT_MESSAGES:
#name=
def
name=
(
value
)
-
>
::
String
- 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} - DEFAULT_DIRECT_MESSAGES:
- (::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} - DEFAULT_DIRECT_MESSAGES:
#sort_order
def
sort_order
()
-
>
::
Integer
- (::Integer) — Output only. The order of the section in relation to other sections.
Sections with a lower
sort_ordervalue appear before sections with a higher value.
#sort_order=
def
sort_order=
(
value
)
-
>
::
Integer
- value(::Integer) — Output only. The order of the section in relation to other sections.
Sections with a lower
sort_ordervalue appear before sections with a higher value.
- (::Integer) — Output only. The order of the section in relation to other sections.
Sections with a lower
sort_ordervalue appear before sections with a higher value.
#type
def
type
()
-
>
::
Google
::
Apps
::
Chat
::
V1
::
Section
::
SectionType
- ( ::Google::Apps::Chat::V1::Section::SectionType ) — Required. The type of the section.
#type=
def
type=
(
value
)
-
>
::
Google
::
Apps
::
Chat
::
V1
::
Section
::
SectionType
- value( ::Google::Apps::Chat::V1::Section::SectionType ) — Required. The type of the section.
- ( ::Google::Apps::Chat::V1::Section::SectionType ) — Required. The type of the section.
