Console
    Contact Us Start free

    Google Chat V1 API - Class Google::Apps::Chat::V1::Space (v0.4.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) — The space's display name. Required when creating a 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) — The space's display name. Required when creating a 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) — The space's display name. Required when creating a 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) — 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.

      • The space is used to import data to Google Chat because import mode spaces must only permit members from the same Google Workspace organization. However, as part of the Google Workspace Developer Preview Program , import mode spaces can permit any Google Chat user so this field can then be set for import mode spaces.

      For existing spaces, this field is output only.

    #external_user_allowed=

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

      • The space is used to import data to Google Chat because import mode spaces must only permit members from the same Google Workspace organization. However, as part of the Google Workspace Developer Preview Program , import mode spaces can permit any Google Chat user so this field can then be set for import mode spaces.

      For existing spaces, this field is output only.

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

      • The space is used to import data to Google Chat because import mode spaces must only permit members from the same Google Workspace organization. However, as part of the Google Workspace Developer Preview Program , import mode spaces can permit any Google Chat user so this field can then be set for import mode spaces.

      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.

    #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.
    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.

    #name

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

      Format: spaces/{space}

    #name=

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

      Format: spaces/{space}

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

      Format: spaces/{space}

    #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: