Console
    Contact Us Start free

    Google Chat V1 API - Class Google::Apps::Chat::V1::Space (v0.13.0)

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

    A space in Google Chat. Spaces are conversations between two or more users or 1:1 messages between a user and a Chat app.

    Inherits

    • Object

    Extended By

    • Google::Protobuf::MessageExts::ClassMethods

    Includes

    • Google::Protobuf::MessageExts

    Methods

    #access_settings

      def 
  
 access_settings 
 () 
  
 - 
>  
 :: 
 Google 
 :: 
 Apps 
 :: 
 Chat 
 :: 
 V1 
 :: 
 Space 
 :: 
 AccessSettings
    Returns

    #access_settings=

      def 
  
 access_settings= 
 ( 
 value 
 ) 
  
 - 
>  
 :: 
 Google 
 :: 
 Apps 
 :: 
 Chat 
 :: 
 V1 
 :: 
 Space 
 :: 
 AccessSettings
    Parameter
    Returns

    #admin_installed

      def 
  
 admin_installed 
 () 
  
 - 
>  
 :: 
 Boolean
    Returns
    • (::Boolean) — Output only. For direct message (DM) spaces with a Chat app, whether the space was created by a Google Workspace administrator. Administrators can install and set up a direct message with a Chat app on behalf of users in their organization.

      To support admin install, your Chat app must feature direct messaging.

    #create_time

      def 
  
 create_time 
 () 
  
 - 
>  
 :: 
 Google 
 :: 
 Protobuf 
 :: 
 Timestamp
    Returns
    • ( ::Google::Protobuf::Timestamp ) — Optional. Immutable. For spaces created in Chat, the time the space was created. This field is output only, except when used in import mode spaces.

      For import mode spaces, set this field to the historical timestamp at which the space was created in the source in order to preserve the original creation time.

      Only populated in the output when spaceType is GROUP_CHAT or SPACE .

    #create_time=

      def 
  
 create_time= 
 ( 
 value 
 ) 
  
 - 
>  
 :: 
 Google 
 :: 
 Protobuf 
 :: 
 Timestamp
    Parameter
    • value( ::Google::Protobuf::Timestamp ) — Optional. Immutable. For spaces created in Chat, the time the space was created. This field is output only, except when used in import mode spaces.

      For import mode spaces, set this field to the historical timestamp at which the space was created in the source in order to preserve the original creation time.

      Only populated in the output when spaceType is GROUP_CHAT or SPACE .

    Returns
    • ( ::Google::Protobuf::Timestamp ) — Optional. Immutable. For spaces created in Chat, the time the space was created. This field is output only, except when used in import mode spaces.

      For import mode spaces, set this field to the historical timestamp at which the space was created in the source in order to preserve the original creation time.

      Only populated in the output when spaceType is GROUP_CHAT or SPACE .

    #display_name

      def 
  
 display_name 
 () 
  
 - 
>  
 :: 
 String
    Returns
    • (::String) — Optional. The space's display name. Required when creating a space with a spaceType of SPACE . If you receive the error message ALREADY_EXISTS when creating a space or updating the displayName , try a different displayName . An existing space within the Google Workspace organization might already use this display name.

      For direct messages, this field might be empty.

      Supports up to 128 characters.

    #display_name=

      def 
  
 display_name= 
 ( 
 value 
 ) 
  
 - 
>  
 :: 
 String
    Parameter
    • value(::String) — Optional. The space's display name. Required when creating a space with a spaceType of SPACE . If you receive the error message ALREADY_EXISTS when creating a space or updating the displayName , try a different displayName . An existing space within the Google Workspace organization might already use this display name.

      For direct messages, this field might be empty.

      Supports up to 128 characters.

    Returns
    • (::String) — Optional. The space's display name. Required when creating a space with a spaceType of SPACE . If you receive the error message ALREADY_EXISTS when creating a space or updating the displayName , try a different displayName . An existing space within the Google Workspace organization might already use this display name.

      For direct messages, this field might be empty.

      Supports up to 128 characters.

    #external_user_allowed

      def 
  
 external_user_allowed 
 () 
  
 - 
>  
 :: 
 Boolean
    Returns
    • (::Boolean) — Optional. Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions:
      • The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user.

      For existing spaces, this field is output only.

    #external_user_allowed=

      def 
  
 external_user_allowed= 
 ( 
 value 
 ) 
  
 - 
>  
 :: 
 Boolean
    Parameter
    • value(::Boolean) — Optional. Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions:
      • The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user.

      For existing spaces, this field is output only.

    Returns
    • (::Boolean) — Optional. Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions:
      • The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user.

      For existing spaces, this field is output only.

    #import_mode

      def 
  
 import_mode 
 () 
  
 - 
>  
 :: 
 Boolean
    Returns
    • (::Boolean) — Optional. Whether this space is created in Import Mode as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete.

      Creating a space in Import Mode requires user authentication .

    #import_mode=

      def 
  
 import_mode= 
 ( 
 value 
 ) 
  
 - 
>  
 :: 
 Boolean
    Parameter
    • value(::Boolean) — Optional. Whether this space is created in Import Mode as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete.

      Creating a space in Import Mode requires user authentication .

    Returns
    • (::Boolean) — Optional. Whether this space is created in Import Mode as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete.

      Creating a space in Import Mode requires user authentication .

    #import_mode_expire_time

      def 
  
 import_mode_expire_time 
 () 
  
 - 
>  
 :: 
 Google 
 :: 
 Protobuf 
 :: 
 Timestamp
    Returns
    • ( ::Google::Protobuf::Timestamp ) — Output only. The time when the space will be automatically deleted by the system if it remains in import mode.

      Each space created in import mode must exit this mode before this expire time using spaces.completeImport .

      This field is only populated for spaces that were created with import mode.

    #last_active_time

      def 
  
 last_active_time 
 () 
  
 - 
>  
 :: 
 Google 
 :: 
 Protobuf 
 :: 
 Timestamp
    Returns

    #membership_count

      def 
  
 membership_count 
 () 
  
 - 
>  
 :: 
 Google 
 :: 
 Apps 
 :: 
 Chat 
 :: 
 V1 
 :: 
 Space 
 :: 
 MembershipCount
    Returns

    #name

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

      Format: spaces/{space}

      Where {space} represents the system-assigned ID for the space. You can obtain the space ID by calling the spaces.list() method or from the space URL. For example, if the space URL is https://mail.google.com/mail/u/0/#chat/space/AAAAAAAAA , the space ID is AAAAAAAAA .

    #name=

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

      Format: spaces/{space}

      Where {space} represents the system-assigned ID for the space. You can obtain the space ID by calling the spaces.list() method or from the space URL. For example, if the space URL is https://mail.google.com/mail/u/0/#chat/space/AAAAAAAAA , the space ID is AAAAAAAAA .

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

      Format: spaces/{space}

      Where {space} represents the system-assigned ID for the space. You can obtain the space ID by calling the spaces.list() method or from the space URL. For example, if the space URL is https://mail.google.com/mail/u/0/#chat/space/AAAAAAAAA , the space ID is AAAAAAAAA .

    #permission_settings

      def 
  
 permission_settings 
 () 
  
 - 
>  
 :: 
 Google 
 :: 
 Apps 
 :: 
 Chat 
 :: 
 V1 
 :: 
 Space 
 :: 
 PermissionSettings
    Returns
    • ( ::Google::Apps::Chat::V1::Space::PermissionSettings ) — Optional. Space permission settings for existing spaces. Input for updating exact space permission settings, where existing permission settings are replaced. Output lists current permission settings.

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

    #permission_settings=

      def 
  
 permission_settings= 
 ( 
 value 
 ) 
  
 - 
>  
 :: 
 Google 
 :: 
 Apps 
 :: 
 Chat 
 :: 
 V1 
 :: 
 Space 
 :: 
 PermissionSettings
    Parameter
    • value( ::Google::Apps::Chat::V1::Space::PermissionSettings ) — Optional. Space permission settings for existing spaces. Input for updating exact space permission settings, where existing permission settings are replaced. Output lists current permission settings.

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

    Returns
    • ( ::Google::Apps::Chat::V1::Space::PermissionSettings ) — Optional. Space permission settings for existing spaces. Input for updating exact space permission settings, where existing permission settings are replaced. Output lists current permission settings.

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

    #predefined_permission_settings

      def 
  
 predefined_permission_settings 
 () 
  
 - 
>  
 :: 
 Google 
 :: 
 Apps 
 :: 
 Chat 
 :: 
 V1 
 :: 
 Space 
 :: 
 PredefinedPermissionSettings
    Returns
    • ( ::Google::Apps::Chat::V1::Space::PredefinedPermissionSettings ) — Optional. Input only. Predefined space permission settings, input only when creating a space. If the field is not set, a collaboration space is created. After you create the space, settings are populated in the PermissionSettings field.

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

    #predefined_permission_settings=

      def 
  
 predefined_permission_settings= 
 ( 
 value 
 ) 
  
 - 
>  
 :: 
 Google 
 :: 
 Apps 
 :: 
 Chat 
 :: 
 V1 
 :: 
 Space 
 :: 
 PredefinedPermissionSettings
    Parameter
    • value( ::Google::Apps::Chat::V1::Space::PredefinedPermissionSettings ) — Optional. Input only. Predefined space permission settings, input only when creating a space. If the field is not set, a collaboration space is created. After you create the space, settings are populated in the PermissionSettings field.

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

    Returns
    • ( ::Google::Apps::Chat::V1::Space::PredefinedPermissionSettings ) — Optional. Input only. Predefined space permission settings, input only when creating a space. If the field is not set, a collaboration space is created. After you create the space, settings are populated in the PermissionSettings field.

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

    #single_user_bot_dm

      def 
  
 single_user_bot_dm 
 () 
  
 - 
>  
 :: 
 Boolean
    Returns
    • (::Boolean) — Optional. Whether the space is a DM between a Chat app and a single human.

    #single_user_bot_dm=

      def 
  
 single_user_bot_dm= 
 ( 
 value 
 ) 
  
 - 
>  
 :: 
 Boolean
    Parameter
    • value(::Boolean) — Optional. Whether the space is a DM between a Chat app and a single human.
    Returns
    • (::Boolean) — Optional. Whether the space is a DM between a Chat app and a single human.

    #space_details

      def 
  
 space_details 
 () 
  
 - 
>  
 :: 
 Google 
 :: 
 Apps 
 :: 
 Chat 
 :: 
 V1 
 :: 
 Space 
 :: 
 SpaceDetails
    Returns

    #space_details=

      def 
  
 space_details= 
 ( 
 value 
 ) 
  
 - 
>  
 :: 
 Google 
 :: 
 Apps 
 :: 
 Chat 
 :: 
 V1 
 :: 
 Space 
 :: 
 SpaceDetails
    Parameter
    Returns

    #space_history_state

      def 
  
 space_history_state 
 () 
  
 - 
>  
 :: 
 Google 
 :: 
 Apps 
 :: 
 Chat 
 :: 
 V1 
 :: 
 HistoryState
    Returns

    #space_history_state=

      def 
  
 space_history_state= 
 ( 
 value 
 ) 
  
 - 
>  
 :: 
 Google 
 :: 
 Apps 
 :: 
 Chat 
 :: 
 V1 
 :: 
 HistoryState
    Parameter
    Returns

    #space_threading_state

      def 
  
 space_threading_state 
 () 
  
 - 
>  
 :: 
 Google 
 :: 
 Apps 
 :: 
 Chat 
 :: 
 V1 
 :: 
 Space 
 :: 
 SpaceThreadingState
    Returns

    #space_type

      def 
  
 space_type 
 () 
  
 - 
>  
 :: 
 Google 
 :: 
 Apps 
 :: 
 Chat 
 :: 
 V1 
 :: 
 Space 
 :: 
 SpaceType
    Returns

    #space_type=

      def 
  
 space_type= 
 ( 
 value 
 ) 
  
 - 
>  
 :: 
 Google 
 :: 
 Apps 
 :: 
 Chat 
 :: 
 V1 
 :: 
 Space 
 :: 
 SpaceType
    Parameter
    Returns

    #space_uri

      def 
  
 space_uri 
 () 
  
 - 
>  
 :: 
 String
    Returns
    • (::String) — Output only. The URI for a user to access the space.

    #threaded

      def 
  
 threaded 
 () 
  
 - 
>  
 :: 
 Boolean
    Returns
    • (::Boolean) — Output only. Deprecated: Use spaceThreadingState instead. Whether messages are threaded in this space.

    #type

      def 
  
 type 
 () 
  
 - 
>  
 :: 
 Google 
 :: 
 Apps 
 :: 
 Chat 
 :: 
 V1 
 :: 
 Space 
 :: 
 Type
    Returns
    Create a Mobile Website
    View Site in Mobile | Classic
    Share by: