Google Chat V1 API - Class Google::Apps::Chat::V1::Space::AccessSettings (v0.28.0)

0.28.0 (latest) 0.27.0 0.26.0 0.25.0 0.24.0 0.23.0 0.22.0 0.21.0 0.20.0 0.19.0 0.18.0 0.17.0 0.16.0 0.15.0 0.14.0 0.13.0 0.12.0 0.11.1 0.10.0 0.9.1 0.8.0 0.7.0 0.6.0 0.5.1 0.4.0 0.3.1 0.2.0 0.1.2

Reference documentation and code samples for the Google Chat V1 API class Google::Apps::Chat::V1::Space::AccessSettings.

Represents the access setting of the space.

Inherits

• Object

Extended By

• Google::Protobuf::MessageExts::ClassMethods

Includes

• Google::Protobuf::MessageExts

Methods

#access_permission_settings

def access_permission_settings() -> ::Google::Apps::Chat::V1::Space::AccessPermissionSettings

Returns

• (::Google::Apps::Chat::V1::Space::AccessPermissionSettings) — Optional. Access permission settings for the space.

  To set the target audience when creating a space, specify the accessSettings.audience field in your request.

#access_permission_settings=

def access_permission_settings=(value) -> ::Google::Apps::Chat::V1::Space::AccessPermissionSettings

Parameter

• value (::Google::Apps::Chat::V1::Space::AccessPermissionSettings) — Optional. Access permission settings for the space.

  To set the target audience when creating a space, specify the accessSettings.audience field in your request.

Returns

• (::Google::Apps::Chat::V1::Space::AccessPermissionSettings) — Optional. Access permission settings for the space.

  To set the target audience when creating a space, specify the accessSettings.audience field in your request.

#access_state

def access_state() -> ::Google::Apps::Chat::V1::Space::AccessSettings::AccessState

Returns

• (::Google::Apps::Chat::V1::Space::AccessSettings::AccessState) — Output only. Indicates the access state of the space.

#audience

def audience() -> ::String

Returns

• (::String) — Optional. The resource name of the target audience who can discover the space, join the space, and preview the messages in the space. If unset, only users or Google Groups who have been individually invited or added to the space can access it. For details, see Make a space discoverable to a target audience.

  Format: audiences/{audience}

  To use the default target audience for the Google Workspace organization, set to audiences/default.

  Reading the target audience supports:

  • User authentication

  • App authentication with administrator approval with the chat.app.spaces scope.

  This field is not populated when using the chat.bot scope with app authentication.

  Setting the target audience requires user authentication.

#audience=

def audience=(value) -> ::String

Parameter

• value (::String) — Optional. The resource name of the target audience who can discover the space, join the space, and preview the messages in the space. If unset, only users or Google Groups who have been individually invited or added to the space can access it. For details, see Make a space discoverable to a target audience.

  Format: audiences/{audience}

  To use the default target audience for the Google Workspace organization, set to audiences/default.

  Reading the target audience supports:

  • User authentication

  • App authentication with administrator approval with the chat.app.spaces scope.

  This field is not populated when using the chat.bot scope with app authentication.

  Setting the target audience requires user authentication.

Returns

• (::String) — Optional. The resource name of the target audience who can discover the space, join the space, and preview the messages in the space. If unset, only users or Google Groups who have been individually invited or added to the space can access it. For details, see Make a space discoverable to a target audience.

  Format: audiences/{audience}

  To use the default target audience for the Google Workspace organization, set to audiences/default.

  Reading the target audience supports:

  • User authentication

  • App authentication with administrator approval with the chat.app.spaces scope.

  This field is not populated when using the chat.bot scope with app authentication.

  Setting the target audience requires user authentication.