class Spaces extends Resource (View source)

The "spaces" collection of methods.

Typical usage is:

 $chatService = new Google\Service\HangoutsChat(...);
 $spaces = $chatService->spaces;

Methods

completeImport(string $name, CompleteImportSpaceRequest $postBody, array $optParams = [])

Completes the import process for the specified space and makes it visible to users. Requires app authentication and domain-wide delegation. For more information, see Authorize Google Chat apps to import data. (spaces.completeImport)

create(Space $postBody, array $optParams = [])

Creates a named space. Spaces grouped by topics aren't supported. For an example, see Create a space. If you receive the error message ALREADY_EXISTS when creating a space, try a different displayName. An existing space within the Google Workspace organization might already use this display name. Requires user authentication. (spaces.create)

delete(string $name, array $optParams = [])

Deletes a named space. Always performs a cascading delete, which means that the space's child resources—like messages posted in the space and memberships in the space—are also deleted. For an example, see Delete a space. Requires user authentication from a user who has permission to delete the space.

findDirectMessage(array $optParams = [])

Returns the existing direct message with the specified user. If no direct message space is found, returns a 404 NOT_FOUND error. For an example, see Find a direct message. With user authentication, returns the direct message space between the specified user and the authenticated user. With app authentication, returns the direct message space between the specified user and the calling Chat app. Requires user authentication or app authentication. (spaces.findDirectMessage)

get(string $name, array $optParams = [])

Returns details about a space. For an example, see Get details about a space. Requires authentication. Supports app authentication and user authentication. (spaces.get)

listSpaces(array $optParams = [])

Lists spaces the caller is a member of. Group chats and DMs aren't listed until the first message is sent. For an example, see List spaces. Requires authentication. Supports app authentication and user authentication. Lists spaces visible to the caller or authenticated user. Group chats and DMs aren't listed until the first message is sent. To list all named spaces by Google Workspace organization, use the spaces.sear ch() method using Workspace administrator privileges instead.

patch(string $name, Space $postBody, array $optParams = [])

Updates a space. For an example, see Update a space. 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. (spaces.patch)

setup(SetUpSpaceRequest $postBody, array $optParams = [])

Creates a space and adds specified users to it. The calling user is automatically added to the space, and shouldn't be specified as a membership in the request. For an example, see Set up a space with initial members. To specify the human members to add, add memberships with the appropriate membership.member.name. To add a human user, use users/{user}, where {user} can be the email address for the user. For users in the same Workspace organization {user} can also be the id for the person from the People API, or the id for the user in the Directory API. For example, if the People API Person profile ID for user@example.com is 123456789, you can add the user to the space by setting the membership.member.name to users/user@example.com or users/123456789. To specify the Google groups to add, add memberships with the appropriate membership.group_member.name.

Details

CompleteImportSpaceResponse completeImport(string $name, CompleteImportSpaceRequest $postBody, array $optParams = [])

Completes the import process for the specified space and makes it visible to users. Requires app authentication and domain-wide delegation. For more information, see Authorize Google Chat apps to import data. (spaces.completeImport)

Parameters

string $name

Required. Resource name of the import mode space. Format: spaces/{space}

CompleteImportSpaceRequest $postBody
array $optParams

Optional parameters.

Return Value

CompleteImportSpaceResponse

Exceptions

Exception

Space create(Space $postBody, array $optParams = [])

Creates a named space. Spaces grouped by topics aren't supported. For an example, see Create a space. If you receive the error message ALREADY_EXISTS when creating a space, try a different displayName. An existing space within the Google Workspace organization might already use this display name. Requires user authentication. (spaces.create)

Parameters

Space $postBody
array $optParams

Optional parameters.

Return Value

Space

Exceptions

Exception

ChatEmpty delete(string $name, array $optParams = [])

Deletes a named space. Always performs a cascading delete, which means that the space's child resources—like messages posted in the space and memberships in the space—are also deleted. For an example, see Delete a space. Requires user authentication from a user who has permission to delete the space.

(spaces.delete)

Parameters

string $name

Required. Resource name of the space to delete. Format: spaces/{space}

array $optParams

Optional parameters.

Return Value

ChatEmpty

Exceptions

Exception

Space findDirectMessage(array $optParams = [])

Returns the existing direct message with the specified user. If no direct message space is found, returns a 404 NOT_FOUND error. For an example, see Find a direct message. With user authentication, returns the direct message space between the specified user and the authenticated user. With app authentication, returns the direct message space between the specified user and the calling Chat app. Requires user authentication or app authentication. (spaces.findDirectMessage)

Parameters

array $optParams

Optional parameters.

Return Value

Space

Exceptions

Exception

Space get(string $name, array $optParams = [])

Returns details about a space. For an example, see Get details about a space. Requires authentication. Supports app authentication and user authentication. (spaces.get)

Parameters

string $name

Required. Resource name of the space, in the form spaces/{space}. Format: spaces/{space}

array $optParams

Optional parameters.

Return Value

Space

Exceptions

Exception

ListSpacesResponse listSpaces(array $optParams = [])

Lists spaces the caller is a member of. Group chats and DMs aren't listed until the first message is sent. For an example, see List spaces. Requires authentication. Supports app authentication and user authentication. Lists spaces visible to the caller or authenticated user. Group chats and DMs aren't listed until the first message is sent. To list all named spaces by Google Workspace organization, use the spaces.sear ch() method using Workspace administrator privileges instead.

(spaces.listSpaces)

Parameters

array $optParams

Optional parameters.

Return Value

ListSpacesResponse

Exceptions

Exception

Space patch(string $name, Space $postBody, array $optParams = [])

Updates a space. For an example, see Update a space. 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. (spaces.patch)

Parameters

string $name

Resource name of the space. Format: spaces/{space}

Space $postBody
array $optParams

Optional parameters.

Return Value

Space

Exceptions

Exception

Space setup(SetUpSpaceRequest $postBody, array $optParams = [])

Creates a space and adds specified users to it. The calling user is automatically added to the space, and shouldn't be specified as a membership in the request. For an example, see Set up a space with initial members. To specify the human members to add, add memberships with the appropriate membership.member.name. To add a human user, use users/{user}, where {user} can be the email address for the user. For users in the same Workspace organization {user} can also be the id for the person from the People API, or the id for the user in the Directory API. For example, if the People API Person profile ID for user@example.com is 123456789, you can add the user to the space by setting the membership.member.name to users/user@example.com or users/123456789. To specify the Google groups to add, add memberships with the appropriate membership.group_member.name.

To add or invite a Google group, use groups/{group}, where {group} is the id for the group from the Cloud Identity Groups API. For example, you can use Cloud Identity Groups lookup API to retrieve the ID 123456789 for group email group@example.com, then you can add the group to the space by setting the membership.group_member.name to groups/123456789. Group email is not supported, and Google groups can only be added as members in named spaces. For a named space or group chat, if the caller blocks, or is blocked by some members, or doesn't have permission to add some members, then those members aren't added to the created space. To create a direct message (DM) between the calling user and another human user, specify exactly one membership to represent the human user. If one user blocks the other, the request fails and the DM isn't created. To create a DM between the calling user and the calling app, set Space.singleUserBotDm to true and don't specify any memberships. You can only use this method to set up a DM with the calling app. To add the calling app as a member of a space or an existing DM between two human users, see Invite or add a user or app to a space. If a DM already exists between two users, even when one user blocks the other at the time a request is made, then the existing DM is returned. Spaces with threaded replies aren't supported. If you receive the error message ALREADY_EXISTS when setting up a space, try a different displayName. An existing space within the Google Workspace organization might already use this display name. Requires user authentication. (spaces.setup)

Parameters

SetUpSpaceRequest $postBody
array $optParams

Optional parameters.

Return Value

Space

Exceptions

Exception