Google Apps Chat V1 Client - Class SearchSpacesResponse (0.28.0)

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

Response with a list of spaces corresponding to the search spaces request.

Generated from protobuf message google.chat.v1.SearchSpacesResponse

Namespace

Google \ Apps \ Chat \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ spaces array<Space>

Deprecated: Please use the new results field instead. A page of the requested spaces. This field will be populated only when useAdminAccess is set to true and deprecated in favor of the new results field.

↳ next_page_token string

A token that can be used to retrieve the next page. If this field is empty, there are no subsequent pages. Only populated when useAdminAccess is set to true.

↳ total_size int

The total number of spaces that match the query, across all pages. If the result is over 10,000 spaces, this value is an estimate. Only populated when useAdminAccess is set to true.

↳ results array<SearchSpacesResponse\SearchSpaceResult>

Output only. The list of search results that matched the query.

getSpaces

Deprecated: Please use the new results field instead.

A page of the requested spaces. This field will be populated only when useAdminAccess is set to true and deprecated in favor of the new results field.

Returns
Type Description
Google\Protobuf\RepeatedField<Space>

setSpaces

Deprecated: Please use the new results field instead.

A page of the requested spaces. This field will be populated only when useAdminAccess is set to true and deprecated in favor of the new results field.

Parameter
Name Description
var array<Space>
Returns
Type Description
$this

getNextPageToken

A token that can be used to retrieve the next page. If this field is empty, there are no subsequent pages.

Only populated when useAdminAccess is set to true.

Returns
Type Description
string

setNextPageToken

A token that can be used to retrieve the next page. If this field is empty, there are no subsequent pages.

Only populated when useAdminAccess is set to true.

Parameter
Name Description
var string
Returns
Type Description
$this

getTotalSize

The total number of spaces that match the query, across all pages. If the result is over 10,000 spaces, this value is an estimate.

Only populated when useAdminAccess is set to true.

Returns
Type Description
int

setTotalSize

The total number of spaces that match the query, across all pages. If the result is over 10,000 spaces, this value is an estimate.

Only populated when useAdminAccess is set to true.

Parameter
Name Description
var int
Returns
Type Description
$this

getResults

Output only. The list of search results that matched the query.

Returns
Type Description
Google\Protobuf\RepeatedField<SearchSpacesResponse\SearchSpaceResult>

setResults

Output only. The list of search results that matched the query.

Parameter
Name Description
var array<SearchSpacesResponse\SearchSpaceResult>
Returns
Type Description
$this