Google Apps Chat V1 Client - Class ListSectionsRequest (0.18.0)

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

Request message for listing sections.

Generated from protobuf message google.chat.v1.ListSectionsRequest

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 user resource name that owns this collection of sections. Only supports listing sections for the calling user. To refer to the calling user, set one of the following: - The me alias. For example, users/me. - Their Workspace email address. For example, users/user\@example.com. - Their user id. For example, users/123456789. Format: users/{user}
↳ page_size int

Optional. The maximum number of sections to return. The service may return fewer than this value. If unspecified, at most 10 sections 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 sections 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.

getParent

Required. The parent, which is the user resource name that owns this collection of sections. Only supports listing sections for the calling user. To refer to the calling user, set one of the following:

  • The me alias. For example, users/me.

  • Their Workspace email address. For example, users/user\@example.com.

  • Their user id. For example, users/123456789. Format: users/{user}
Returns
Type Description
string

setParent

Required. The parent, which is the user resource name that owns this collection of sections. Only supports listing sections for the calling user. To refer to the calling user, set one of the following:

  • The me alias. For example, users/me.

  • Their Workspace email address. For example, users/user\@example.com.

  • Their user id. For example, users/123456789. Format: users/{user}
Parameter
Name Description
var string
Returns
Type Description
$this

getPageSize

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

If unspecified, at most 10 sections 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 sections to return. The service may return fewer than this value.

If unspecified, at most 10 sections 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 sections 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 sections 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

static::build

Parameter
Name Description
parent string

Required. The parent, which is the user resource name that owns this collection of sections. Only supports listing sections for the calling user. To refer to the calling user, set one of the following:

  • The me alias. For example, users/me.

  • Their Workspace email address. For example, users/user@example.com.

  • Their user id. For example, users/123456789.

Format: users/{user} Please see ChatServiceClient::userName() for help formatting this field.
Returns
Type Description
ListSectionsRequest