0.31.0 (latest) 0.30.0 0.29.0 0.28.0 0.27.0 0.23.0 0.20.0 0.19.0 0.18.0 0.17.1 0.16.1 0.15.0 0.14.0 0.13.1 0.12.1 0.11.2 0.10.0 0.9.0 0.8.1 0.7.2 0.6.1 0.5.0 0.4.0 0.3.0 0.2.0 0.1.4 Reference documentation and code samples for the Google Apps Chat V1 Client class GetMembershipRequest.

Request to get a membership of a space.

Generated from protobuf message `google.chat.v1.GetMembershipRequest`

## Namespace

Google \\ Apps \\ Chat \\ V1

## Methods

### __construct

Constructor.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `data` | `array` Optional. Data for populating the Message object. |
| `↳ name` | `string` Required. Resource name of the membership to retrieve. To get the app's own membership [by using user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), you can optionally use `spaces/{space}/members/app`. Format: `spaces/{space}/members/{member}` or `spaces/{space}/members/app` You can use the user's email as an alias for `{member}`. For example, `spaces/{space}/members/example\@gmail.com` where `example\@gmail.com` is the email of the Google Chat user. |
| `↳ use_admin_access` | `bool` Optional. When `true`, the method runs using the user's Google Workspace administrator privileges. The calling user must be a Google Workspace administrator with the [manage chat and spaces conversations privilege](https://support.google.com/a/answer/13369245). Requires the `chat.admin.memberships` or `chat.admin.memberships.readonly` [OAuth 2.0 scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes). Getting app memberships in a space isn't supported when using admin access. |

### getName

Required. Resource name of the membership to retrieve.

To get the app's own membership [by using user
authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user),
you can optionally use `spaces/{space}/members/app`.
Format: `spaces/{space}/members/{member}` or `spaces/{space}/members/app`
You can use the user's email as an alias for `{member}`. For example,
`spaces/{space}/members/example\@gmail.com` where `example\@gmail.com` is the
email of the Google Chat user.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` |   |

### setName

Required. Resource name of the membership to retrieve.

To get the app's own membership [by using user
authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user),
you can optionally use `spaces/{space}/members/app`.
Format: `spaces/{space}/members/{member}` or `spaces/{space}/members/app`
You can use the user's email as an alias for `{member}`. For example,
`spaces/{space}/members/example\@gmail.com` where `example\@gmail.com` is the
email of the Google Chat user.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getUseAdminAccess

Optional. When `true`, the method runs using the user's Google Workspace
administrator privileges.

The calling user must be a Google Workspace administrator with the
[manage chat and spaces conversations
privilege](https://support.google.com/a/answer/13369245).
Requires the `chat.admin.memberships` or `chat.admin.memberships.readonly`
[OAuth 2.0
scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes).
Getting app memberships in a space isn't supported when using admin access.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `bool` |   |

### setUseAdminAccess

Optional. When `true`, the method runs using the user's Google Workspace
administrator privileges.

The calling user must be a Google Workspace administrator with the
[manage chat and spaces conversations
privilege](https://support.google.com/a/answer/13369245).
Requires the `chat.admin.memberships` or `chat.admin.memberships.readonly`
[OAuth 2.0
scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes).
Getting app memberships in a space isn't supported when using admin access.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `bool` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### static::build

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `name` | `string` Required. Resource name of the membership to retrieve. To get the app's own membership [by using user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), you can optionally use `spaces/{space}/members/app`. Format: `spaces/{space}/members/{member}` or `spaces/{space}/members/app` You can use the user's email as an alias for `{member}`. For example, `spaces/{space}/members/example@gmail.com` where `example@gmail.com` is the email of the Google Chat user. Please see ChatServiceClient::membershipName() for help formatting this field. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `GetMembershipRequest` |   |