All Downloads are FREE. Search and download functionalities are using the official Maven repository.
  • Log In
  • Register

    • target.apidocs.com.google.api.services.chat.v1.HangoutsChat.Spaces.Patch.html Maven / Gradle / Ivy

    There is a newer version: v1-rev20241217-2.0.0
    Show newest version
    





HangoutsChat.Spaces.Patch (Google Chat API v1-rev20240829-2.0.0)









    



    Skip navigation links
    





    

    




    


    

    



    



    



    

    com.google.api.services.chat.v1
    

    Class HangoutsChat.Spaces.Patch
    

    

    


    


    

    


    

    

      

    • 


        

      • 



        Constructor Detail
        




          

        • 

          Patch
          

          protected Patch(String name,
                Space content)
          

          Updates a space. For an example, see [Update a
 space](https://developers.google.com/workspace/chat/update-spaces). If you're updating the
 `displayName` field and receive the error message `ALREADY_EXISTS`, try a different display
 name.. An existing space within the Google Workspace organization might already use this
 display name. Requires [user
 authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).

 Create a request for the method "spaces.patch".

 This request holds the parameters needed by the the chat server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation. 
           HangoutsChat.initialize(com.google.api.client.googleapis.services.AbstractGoogleClientRequest) must
 be called to initialize this instance immediately after invoking the constructor. 
          

          

          Parameters:
          

          name - 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()`](https://dev
        elopers.google.com/workspace/chat/api/reference/rest/v1/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`.
          

          content - the Space
          

          Since:
          

          1.13
          

          

          • 

        

        • 

      


        

      • 



        Method Detail
        
















































          

        • 

          getName
          

          public String getName()
          

          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()`](https://developers.google.com/workspace/chat/api/reference/rest/v1/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`.
          

          • 

        




          

        • 

          setName
          

          public HangoutsChat.Spaces.Patch setName(String name)
          

          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()`](htt
 ps://developers.google.com/workspace/chat/api/reference/rest/v1/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`.
          

          • 

        




          

        • 

          getUpdateMask
          

          public String getUpdateMask()
          

          Required. The updated field paths, comma separated if there are multiple. You can update the
     following fields for a space: - `space_details` - `display_name`: Only supports updating the
     display name for spaces where `spaceType` field is `SPACE`. If you receive the error message
     `ALREADY_EXISTS`, try a different value. An existing space within the Google Workspace organization
     might already use this display name. - `space_type`: Only supports changing a `GROUP_CHAT` space
     type to `SPACE`. Include `display_name` together with `space_type` in the update mask and ensure
     that the specified space has a non-empty display name and the `SPACE` space type. Including the
     `space_type` mask and the `SPACE` type in the specified space when updating the display name is
     optional if the existing space already has the `SPACE` type. Trying to update the space type in
     other ways results in an invalid argument error. `space_type` is not supported with admin access. -
     `space_history_state`: Updates [space history
     settings](https://support.google.com/chat/answer/7664687) by turning history on or off for the
     space. Only supported if history settings are enabled for the Google Workspace organization. To
     update the space history state, you must omit all other field masks in your request.
     `space_history_state` is not supported with admin access. - `access_settings.audience`: Updates the
     [access setting](https://support.google.com/chat/answer/11971020) of who can discover the space,
     join the space, and preview the messages in named space where `spaceType` field is `SPACE`. If the
     existing space has a target audience, you can remove the audience and restrict space access by
     omitting a value for this field mask. To update access settings for a space, the authenticating
     user must be a space manager and omit all other field masks in your request. You can't update this
     field if the space is in [import mode](https://developers.google.com/workspace/chat/import-data-
     overview). To learn more, see [Make a space discoverable to specific
     users](https://developers.google.com/workspace/chat/space-target-audience).
     `access_settings.audience` is not supported with admin access. - Developer Preview: Supports
     changing the [permission settings](https://support.google.com/chat/answer/13340792) of a space,
     supported field paths include: `permission_settings.manage_members_and_groups`,
     `permission_settings.modify_space_details`, `permission_settings.toggle_history`,
     `permission_settings.use_at_mention_all`, `permission_settings.manage_apps`,
     `permission_settings.manage_webhooks`, `permission_settings.reply_messages` (Warning: mutually
     exclusive with all other non-permission settings field paths). `permission_settings` is not
     supported with admin access.
          

          • 

        




          

        • 

          setUpdateMask
          

          public HangoutsChat.Spaces.Patch setUpdateMask(String updateMask)
          

          Required. The updated field paths, comma separated if there are multiple. You can update
 the following fields for a space: - `space_details` - `display_name`: Only supports
 updating the display name for spaces where `spaceType` field is `SPACE`. If you receive the
 error message `ALREADY_EXISTS`, try a different value. An existing space within the Google
 Workspace organization might already use this display name. - `space_type`: Only supports
 changing a `GROUP_CHAT` space type to `SPACE`. Include `display_name` together with
 `space_type` in the update mask and ensure that the specified space has a non-empty display
 name and the `SPACE` space type. Including the `space_type` mask and the `SPACE` type in
 the specified space when updating the display name is optional if the existing space
 already has the `SPACE` type. Trying to update the space type in other ways results in an
 invalid argument error. `space_type` is not supported with admin access. -
 `space_history_state`: Updates [space history
 settings](https://support.google.com/chat/answer/7664687) by turning history on or off for
 the space. Only supported if history settings are enabled for the Google Workspace
 organization. To update the space history state, you must omit all other field masks in
 your request. `space_history_state` is not supported with admin access. -
 `access_settings.audience`: Updates the [access
 setting](https://support.google.com/chat/answer/11971020) of who can discover the space,
 join the space, and preview the messages in named space where `spaceType` field is `SPACE`.
 If the existing space has a target audience, you can remove the audience and restrict space
 access by omitting a value for this field mask. To update access settings for a space, the
 authenticating user must be a space manager and omit all other field masks in your request.
 You can't update this field if the space is in [import
 mode](https://developers.google.com/workspace/chat/import-data-overview). To learn more,
 see [Make a space discoverable to specific
 users](https://developers.google.com/workspace/chat/space-target-audience).
 `access_settings.audience` is not supported with admin access. - Developer Preview:
 Supports changing the [permission
 settings](https://support.google.com/chat/answer/13340792) of a space, supported field
 paths include: `permission_settings.manage_members_and_groups`,
 `permission_settings.modify_space_details`, `permission_settings.toggle_history`,
 `permission_settings.use_at_mention_all`, `permission_settings.manage_apps`,
 `permission_settings.manage_webhooks`, `permission_settings.reply_messages` (Warning:
 mutually exclusive with all other non-permission settings field paths).
 `permission_settings` is not supported with admin access.
          

          • 

        




          

        • 

          getUseAdminAccess
          

          public Boolean getUseAdminAccess()
          

          [ Developer Preview](https://developers.google.com/workspace/preview). When `true`, the method runs
    [ using the user's Google Workspace administrator privileges. The calling user must be a Google
    [ Workspace administrator with the [manage chat and spaces conversations
    [ privilege](https://support.google.com/a/answer/13369245). Requires the `chat.admin.spaces` [OAuth
    [ 2.0 scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes).
    [ Some `FieldMask` values are not supported using admin access. For details, see the description of
    [ `update_mask`.
    [
          

          • 

        




          

        • 

          setUseAdminAccess
          

          public HangoutsChat.Spaces.Patch setUseAdminAccess(Boolean useAdminAccess)
          

          [Developer Preview](https://developers.google.com/workspace/preview). When `true`, the
 method runs using the user's Google Workspace administrator privileges. The calling user
 must be a Google Workspace administrator with the [manage chat and spaces conversations
 privilege](https://support.google.com/a/answer/13369245). Requires the `chat.admin.spaces`
 [OAuth 2.0 scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-
 api-scopes). Some `FieldMask` values are not supported using admin access. For details, see
 the description of `update_mask`.
          

          • 

        





        • 

      

      • 

    

    

    



    



    Skip navigation links
    





    

    




    


    

    



    



    


    Copyright © 2011–2024 Google. All rights reserved.




    © 2015 - 2024 Weber Informatics LLC | Privacy Policy