Console
    Contact Us Start free

    Google Apps Chat V1 Client - Class UpdateSpaceRequest (0.3.0)

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

    A request to update a single space.

    Generated from protobuf message google.chat.v1.UpdateSpaceRequest

    Namespace

    Google \ Apps \ Chat \ V1

    Methods

    __construct

    Constructor.

    Parameters
    Name
    Description
    data
    array

    Optional. Data for populating the Message object.

    ↳ space
    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
    Google\Protobuf\FieldMask

    Required. The updated field paths, comma separated if there are multiple. Currently supported field paths: - display_name (Only supports changing the display name of a space with the SPACE type, or when also including the space_type mask to change a GROUP_CHAT space type to SPACE . Trying to update the display name of a GROUP_CHAT or a DIRECT_MESSAGE space results in an invalid argument error. If you receive the error message ALREADY_EXISTS when updating the displayName , try a different displayName . 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_details - space_history_state (Supports turning history on or off for the space if the organization allows users to change their history setting . Warning: mutually exclusive with all other field paths.) space_history_state is not supported with admin access. - access_settings.audience (Supports changing the access setting of who can discover the space, join the space, and preview the messages in space. If no audience is specified in the access setting, the space's access setting is updated to private. Warning: mutually exclusive with all other field paths.) access_settings.audience is not supported with admin access. - Developer Preview: Supports changing the permission settings 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.

    getSpace

    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
    Type
    Description
    Google\Apps\Chat\V1\Space |null

    hasSpace

    clearSpace

    setSpace

    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.

    Parameter
    Name
    Description
    var
    Google\Apps\Chat\V1\Space
    Returns
    Type
    Description
    $this

    getUpdateMask

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

    Currently supported field paths:

    • display_name (Only supports changing the display name of a space with the SPACE type, or when also including the space_type mask to change a GROUP_CHAT space type to SPACE . Trying to update the display name of a GROUP_CHAT or a DIRECT_MESSAGE space results in an invalid argument error. If you receive the error message ALREADY_EXISTS when updating the displayName , try a different displayName . 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_details
    • space_history_state (Supports turning history on or off for the space if the organization allows users to change their history setting . Warning: mutually exclusive with all other field paths.) space_history_state is not supported with admin access.
    • access_settings.audience (Supports changing the access setting of who can discover the space, join the space, and preview the messages in space. If no audience is specified in the access setting, the space's access setting is updated to private. Warning: mutually exclusive with all other field paths.) access_settings.audience is not supported with admin access.
    • Developer Preview: Supports changing the permission settings 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.
    Returns
    Type
    Description
    Google\Protobuf\FieldMask |null

    hasUpdateMask

    clearUpdateMask

    setUpdateMask

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

    Currently supported field paths:

    • display_name (Only supports changing the display name of a space with the SPACE type, or when also including the space_type mask to change a GROUP_CHAT space type to SPACE . Trying to update the display name of a GROUP_CHAT or a DIRECT_MESSAGE space results in an invalid argument error. If you receive the error message ALREADY_EXISTS when updating the displayName , try a different displayName . 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_details
    • space_history_state (Supports turning history on or off for the space if the organization allows users to change their history setting . Warning: mutually exclusive with all other field paths.) space_history_state is not supported with admin access.
    • access_settings.audience (Supports changing the access setting of who can discover the space, join the space, and preview the messages in space. If no audience is specified in the access setting, the space's access setting is updated to private. Warning: mutually exclusive with all other field paths.) access_settings.audience is not supported with admin access.
    • Developer Preview: Supports changing the permission settings 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.
    Parameter
    Name
    Description
    var
    Google\Protobuf\FieldMask
    Returns
    Type
    Description
    $this

    static::build

    Parameters
    Name
    Description
    space
    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.

    updateMask
    Google\Protobuf\FieldMask

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

    Currently supported field paths:

    • display_name (Only supports changing the display name of a space with the SPACE type, or when also including the space_type mask to change a GROUP_CHAT space type to SPACE . Trying to update the display name of a GROUP_CHAT or a DIRECT_MESSAGE space results in an invalid argument error. If you receive the error message ALREADY_EXISTS when updating the displayName , try a different displayName . 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_details

    • space_history_state (Supports turning history on or off for the space if the organization allows users to change their history setting . Warning: mutually exclusive with all other field paths.) space_history_state is not supported with admin access.

    • access_settings.audience (Supports changing the access setting of who can discover the space, join the space, and preview the messages in space. If no audience is specified in the access setting, the space's access setting is updated to private. Warning: mutually exclusive with all other field paths.) access_settings.audience is not supported with admin access.

    • Developer Preview: Supports changing the permission settings 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.

    Returns
    Type
    Description
    Google\Apps\Chat\V1\UpdateSpaceRequest
    Create a Mobile Website
    View Site in Mobile | Classic
    Share by: