Class: Google::Apps::Chat::V1::Space::AccessSettings

Inherits:

Object

• Object
• Google::Apps::Chat::V1::Space::AccessSettings

Extended by:

Protobuf::MessageExts::ClassMethods

Includes:

Protobuf::MessageExts

Defined in:

proto_docs/google/chat/v1/space.rb

Overview

Represents the access setting of the space.

Defined Under Namespace

Modules: AccessState

Instance Attribute Summary

• #access_state ⇒ ::Google::Apps::Chat::V1::Space::AccessSettings::AccessState readonly

  Output only.

• #audience ⇒ ::String

  Optional.

Instance Attribute Details

#access_state ⇒ ::Google::Apps::Chat::V1::Space::AccessSettings::AccessState (readonly)

Returns Output only. Indicates the access state of the space.

Returns:

• (::Google::Apps::Chat::V1::Space::AccessSettings::AccessState) —

  Output only. Indicates the access state of the space.

# File 'proto_docs/google/chat/v1/space.rb', line 261

class AccessSettings
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Represents the access state of the space.
  module AccessState
    # Access state is unknown or not supported in this API.
    ACCESS_STATE_UNSPECIFIED = 0

    # Only users or Google Groups that have been individually added or
    # invited by other users or Google Workspace administrators can discover
    # and access the space.
    PRIVATE = 1

    # A space manager has granted a target audience access to
    # the space. Users or Google Groups that have been individually added or
    # invited to the space can also discover and access the space. To learn
    # more, see [Make a space discoverable to specific
    # users](https://developers.google.com/workspace/chat/space-target-audience).
    #
    # Creating discoverable spaces requires [user
    # authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
    DISCOVERABLE = 2
  end
end

#audience ⇒ ::String

Returns 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.

# File 'proto_docs/google/chat/v1/space.rb', line 261

class AccessSettings
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Represents the access state of the space.
  module AccessState
    # Access state is unknown or not supported in this API.
    ACCESS_STATE_UNSPECIFIED = 0

    # Only users or Google Groups that have been individually added or
    # invited by other users or Google Workspace administrators can discover
    # and access the space.
    PRIVATE = 1

    # A space manager has granted a target audience access to
    # the space. Users or Google Groups that have been individually added or
    # invited to the space can also discover and access the space. To learn
    # more, see [Make a space discoverable to specific
    # users](https://developers.google.com/workspace/chat/space-target-audience).
    #
    # Creating discoverable spaces requires [user
    # authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
    DISCOVERABLE = 2
  end
end