Google Apps Chat V1 Client - Class ListSectionItemsRequest (0.18.0)

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

Request message for listing section items.

Generated from protobuf message google.chat.v1.ListSectionItemsRequest

Namespace

Google \ Apps \ Chat \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ parent string

Required. The parent, which is the section resource name that owns this collection of section items. Only supports listing section items for the calling user. When you're filtering by space, use the wildcard - to search across all sections. For example, users/{user}/sections/-. Format: users/{user}/sections/{section}

↳ page_size int

Optional. The maximum number of section items to return. The service may return fewer than this value. If unspecified, at most 10 section items will be returned. The maximum value is 100. If you use a value more than 100, it's automatically changed to 100. Negative values return an INVALID_ARGUMENT error.

↳ page_token string

Optional. A page token, received from a previous list section items call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided should match the call that provided the page token. Passing different values to the other parameters might lead to unexpected results.

↳ filter string

Optional. A query filter. Currently only supports filtering by space. For example, space = spaces/{space}. Invalid queries are rejected with an INVALID_ARGUMENT error.

getParent

Required. The parent, which is the section resource name that owns this collection of section items. Only supports listing section items for the calling user.

When you're filtering by space, use the wildcard - to search across all sections. For example, users/{user}/sections/-. Format: users/{user}/sections/{section}

Returns
Type Description
string

setParent

Required. The parent, which is the section resource name that owns this collection of section items. Only supports listing section items for the calling user.

When you're filtering by space, use the wildcard - to search across all sections. For example, users/{user}/sections/-. Format: users/{user}/sections/{section}

Parameter
Name Description
var string
Returns
Type Description
$this

getPageSize

Optional. The maximum number of section items to return. The service may return fewer than this value.

If unspecified, at most 10 section items will be returned. The maximum value is 100. If you use a value more than 100, it's automatically changed to 100. Negative values return an INVALID_ARGUMENT error.

Returns
Type Description
int

setPageSize

Optional. The maximum number of section items to return. The service may return fewer than this value.

If unspecified, at most 10 section items will be returned. The maximum value is 100. If you use a value more than 100, it's automatically changed to 100. Negative values return an INVALID_ARGUMENT error.

Parameter
Name Description
var int
Returns
Type Description
$this

getPageToken

Optional. A page token, received from a previous list section items call.

Provide this to retrieve the subsequent page. When paginating, all other parameters provided should match the call that provided the page token. Passing different values to the other parameters might lead to unexpected results.

Returns
Type Description
string

setPageToken

Optional. A page token, received from a previous list section items call.

Provide this to retrieve the subsequent page. When paginating, all other parameters provided should match the call that provided the page token. Passing different values to the other parameters might lead to unexpected results.

Parameter
Name Description
var string
Returns
Type Description
$this

getFilter

Optional. A query filter.

Currently only supports filtering by space. For example, space = spaces/{space}. Invalid queries are rejected with an INVALID_ARGUMENT error.

Returns
Type Description
string

setFilter

Optional. A query filter.

Currently only supports filtering by space. For example, space = spaces/{space}. Invalid queries are rejected with an INVALID_ARGUMENT error.

Parameter
Name Description
var string
Returns
Type Description
$this

static::build

Parameter
Name Description
parent string

Required. The parent, which is the section resource name that owns this collection of section items. Only supports listing section items for the calling user.

When you're filtering by space, use the wildcard - to search across all sections. For example, users/{user}/sections/-.

Format: users/{user}/sections/{section} Please see ChatServiceClient::sectionName() for help formatting this field.

Returns
Type Description
ListSectionItemsRequest