Google Chat V1 API - Class Google::Apps::Chat::V1::UpdateSpaceRequest (v0.16.0)

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

A request to update a single space.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#space

def space() -> ::Google::Apps::Chat::V1::Space
Returns
  • (::Google::Apps::Chat::V1::Space) — Required. Space with fields to be updated. Space.name must be populated in the form of spaces/{space}. Only fields specified by update_mask are updated.

#space=

def space=(value) -> ::Google::Apps::Chat::V1::Space
Parameter
  • value (::Google::Apps::Chat::V1::Space) — Required. Space with fields to be updated. Space.name must be populated in the form of spaces/{space}. Only fields specified by update_mask are updated.
Returns
  • (::Google::Apps::Chat::V1::Space) — Required. Space with fields to be updated. Space.name must be populated in the form of spaces/{space}. Only fields specified by update_mask are updated.

#update_mask

def update_mask() -> ::Google::Protobuf::FieldMask
Returns
  • (::Google::Protobuf::FieldMask) —

    Required. The updated field paths, comma separated if there are multiple.

    You can update the following fields for a space:

    space_details: Updates the space's description. Supports up to 150 characters.

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

    space_history_state: Updates space history settings 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 useAdminAccess.

    access_settings.audience: Updates the access setting 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. To learn more, see Make a space discoverable to specific users. access_settings.audience is not supported with useAdminAccess.

    permission_settings: Supports changing the permission settings of a space. When updating permission settings, you can only specify permissionSettings field masks; you cannot update other field masks at the same time. permissionSettings is not supported with useAdminAccess. The supported field masks include:

    • permission_settings.manageMembersAndGroups
    • permission_settings.modifySpaceDetails
    • permission_settings.toggleHistory
    • permission_settings.useAtMentionAll
    • permission_settings.manageApps
    • permission_settings.manageWebhooks
    • permission_settings.replyMessages

#update_mask=

def update_mask=(value) -> ::Google::Protobuf::FieldMask
Parameter
  • value (::Google::Protobuf::FieldMask) —

    Required. The updated field paths, comma separated if there are multiple.

    You can update the following fields for a space:

    space_details: Updates the space's description. Supports up to 150 characters.

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

    space_history_state: Updates space history settings 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 useAdminAccess.

    access_settings.audience: Updates the access setting 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. To learn more, see Make a space discoverable to specific users. access_settings.audience is not supported with useAdminAccess.

    permission_settings: Supports changing the permission settings of a space. When updating permission settings, you can only specify permissionSettings field masks; you cannot update other field masks at the same time. permissionSettings is not supported with useAdminAccess. The supported field masks include:

    • permission_settings.manageMembersAndGroups
    • permission_settings.modifySpaceDetails
    • permission_settings.toggleHistory
    • permission_settings.useAtMentionAll
    • permission_settings.manageApps
    • permission_settings.manageWebhooks
    • permission_settings.replyMessages
Returns
  • (::Google::Protobuf::FieldMask) —

    Required. The updated field paths, comma separated if there are multiple.

    You can update the following fields for a space:

    space_details: Updates the space's description. Supports up to 150 characters.

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

    space_history_state: Updates space history settings 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 useAdminAccess.

    access_settings.audience: Updates the access setting 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. To learn more, see Make a space discoverable to specific users. access_settings.audience is not supported with useAdminAccess.

    permission_settings: Supports changing the permission settings of a space. When updating permission settings, you can only specify permissionSettings field masks; you cannot update other field masks at the same time. permissionSettings is not supported with useAdminAccess. The supported field masks include:

    • permission_settings.manageMembersAndGroups
    • permission_settings.modifySpaceDetails
    • permission_settings.toggleHistory
    • permission_settings.useAtMentionAll
    • permission_settings.manageApps
    • permission_settings.manageWebhooks
    • permission_settings.replyMessages

#use_admin_access

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

    Requires the chat.admin.spaces OAuth 2.0 scope.

    Some FieldMask values are not supported using admin access. For details, see the description of update_mask.

#use_admin_access=

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

    Requires the chat.admin.spaces OAuth 2.0 scope.

    Some FieldMask values are not supported using admin access. For details, see the description of update_mask.

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

    Requires the chat.admin.spaces OAuth 2.0 scope.

    Some FieldMask values are not supported using admin access. For details, see the description of update_mask.