Class: Google::Apps::Chat::V1::Membership

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/chat/v1/membership.rb

Overview

Represents a membership relation in Google Chat, such as whether a user or Chat app is invited to, part of, or absent from a space.

Defined Under Namespace

Modules: MembershipRole, MembershipState

Instance Attribute Summary collapse

Instance Attribute Details

#create_time ⇒ ::Google::Protobuf::Timestamp

Returns Optional. Immutable. The creation time of the membership, such as when a member joined or was invited to join a space. This field is output only, except when used to import historical memberships in import mode spaces.

Returns:

  • (::Google::Protobuf::Timestamp) —

    Optional. Immutable. The creation time of the membership, such as when a member joined or was invited to join a space. This field is output only, except when used to import historical memberships in import mode spaces.



64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'proto_docs/google/chat/v1/membership.rb', line 64

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

  # Specifies the member's relationship with a space. Other membership states
  # might be supported in the future.
  module MembershipState
    # Default value. Don't use.
    MEMBERSHIP_STATE_UNSPECIFIED = 0

    # The user is added to the space, and can participate in the space.
    JOINED = 1

    # The user is invited to join the space, but hasn't joined it.
    INVITED = 2

    # The user doesn't belong to the space and doesn't have a pending
    # invitation to join the space.
    NOT_A_MEMBER = 3
  end

  # Represents a user's permitted actions in a Chat space. More enum values
  # might be added in the future.
  module MembershipRole
    # Default value. For {::Google::Apps::Chat::V1::Membership#member users}: they
    # aren't a member of the space, but can be invited. For
    # {::Google::Apps::Chat::V1::Membership#group_member Google Groups}: they're always
    #  assigned this role (other enum values might be used in the future).
    MEMBERSHIP_ROLE_UNSPECIFIED = 0

    # A member of the space. The user has basic permissions, like sending
    # messages to the space. In 1:1 and unnamed group conversations, everyone
    # has this role.
    ROLE_MEMBER = 1

    # A space manager. The user has all basic permissions plus administrative
    # permissions that let them manage the space, like adding or removing
    # members. Only supported in
    # {::Google::Apps::Chat::V1::Space::SpaceType SpaceType.SPACE}.
    ROLE_MANAGER = 2
  end
end

#delete_time ⇒ ::Google::Protobuf::Timestamp

Returns Optional. Immutable. The deletion time of the membership, such as when a member left or was removed from a space. This field is output only, except when used to import historical memberships in import mode spaces.

Returns:

  • (::Google::Protobuf::Timestamp) —

    Optional. Immutable. The deletion time of the membership, such as when a member left or was removed from a space. This field is output only, except when used to import historical memberships in import mode spaces.



64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'proto_docs/google/chat/v1/membership.rb', line 64

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

  # Specifies the member's relationship with a space. Other membership states
  # might be supported in the future.
  module MembershipState
    # Default value. Don't use.
    MEMBERSHIP_STATE_UNSPECIFIED = 0

    # The user is added to the space, and can participate in the space.
    JOINED = 1

    # The user is invited to join the space, but hasn't joined it.
    INVITED = 2

    # The user doesn't belong to the space and doesn't have a pending
    # invitation to join the space.
    NOT_A_MEMBER = 3
  end

  # Represents a user's permitted actions in a Chat space. More enum values
  # might be added in the future.
  module MembershipRole
    # Default value. For {::Google::Apps::Chat::V1::Membership#member users}: they
    # aren't a member of the space, but can be invited. For
    # {::Google::Apps::Chat::V1::Membership#group_member Google Groups}: they're always
    #  assigned this role (other enum values might be used in the future).
    MEMBERSHIP_ROLE_UNSPECIFIED = 0

    # A member of the space. The user has basic permissions, like sending
    # messages to the space. In 1:1 and unnamed group conversations, everyone
    # has this role.
    ROLE_MEMBER = 1

    # A space manager. The user has all basic permissions plus administrative
    # permissions that let them manage the space, like adding or removing
    # members. Only supported in
    # {::Google::Apps::Chat::V1::Space::SpaceType SpaceType.SPACE}.
    ROLE_MANAGER = 2
  end
end

#group_member ⇒ ::Google::Apps::Chat::V1::Group

Returns Optional. The Google Group the membership corresponds to.

Reading or mutating memberships for Google Groups requires user authentication.

Returns:



64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'proto_docs/google/chat/v1/membership.rb', line 64

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

  # Specifies the member's relationship with a space. Other membership states
  # might be supported in the future.
  module MembershipState
    # Default value. Don't use.
    MEMBERSHIP_STATE_UNSPECIFIED = 0

    # The user is added to the space, and can participate in the space.
    JOINED = 1

    # The user is invited to join the space, but hasn't joined it.
    INVITED = 2

    # The user doesn't belong to the space and doesn't have a pending
    # invitation to join the space.
    NOT_A_MEMBER = 3
  end

  # Represents a user's permitted actions in a Chat space. More enum values
  # might be added in the future.
  module MembershipRole
    # Default value. For {::Google::Apps::Chat::V1::Membership#member users}: they
    # aren't a member of the space, but can be invited. For
    # {::Google::Apps::Chat::V1::Membership#group_member Google Groups}: they're always
    #  assigned this role (other enum values might be used in the future).
    MEMBERSHIP_ROLE_UNSPECIFIED = 0

    # A member of the space. The user has basic permissions, like sending
    # messages to the space. In 1:1 and unnamed group conversations, everyone
    # has this role.
    ROLE_MEMBER = 1

    # A space manager. The user has all basic permissions plus administrative
    # permissions that let them manage the space, like adding or removing
    # members. Only supported in
    # {::Google::Apps::Chat::V1::Space::SpaceType SpaceType.SPACE}.
    ROLE_MANAGER = 2
  end
end

#member ⇒ ::Google::Apps::Chat::V1::User

Returns Optional. The Google Chat user or app the membership corresponds to. If your Chat app authenticates as a user, the output populates the user name and type.

Returns:



64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'proto_docs/google/chat/v1/membership.rb', line 64

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

  # Specifies the member's relationship with a space. Other membership states
  # might be supported in the future.
  module MembershipState
    # Default value. Don't use.
    MEMBERSHIP_STATE_UNSPECIFIED = 0

    # The user is added to the space, and can participate in the space.
    JOINED = 1

    # The user is invited to join the space, but hasn't joined it.
    INVITED = 2

    # The user doesn't belong to the space and doesn't have a pending
    # invitation to join the space.
    NOT_A_MEMBER = 3
  end

  # Represents a user's permitted actions in a Chat space. More enum values
  # might be added in the future.
  module MembershipRole
    # Default value. For {::Google::Apps::Chat::V1::Membership#member users}: they
    # aren't a member of the space, but can be invited. For
    # {::Google::Apps::Chat::V1::Membership#group_member Google Groups}: they're always
    #  assigned this role (other enum values might be used in the future).
    MEMBERSHIP_ROLE_UNSPECIFIED = 0

    # A member of the space. The user has basic permissions, like sending
    # messages to the space. In 1:1 and unnamed group conversations, everyone
    # has this role.
    ROLE_MEMBER = 1

    # A space manager. The user has all basic permissions plus administrative
    # permissions that let them manage the space, like adding or removing
    # members. Only supported in
    # {::Google::Apps::Chat::V1::Space::SpaceType SpaceType.SPACE}.
    ROLE_MANAGER = 2
  end
end

#name ⇒ ::String

Returns Identifier. Resource name of the membership, assigned by the server.

Format: spaces/{space}/members/{member}.

Returns:

  • (::String) —

    Identifier. Resource name of the membership, assigned by the server.

    Format: spaces/{space}/members/{member}



64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'proto_docs/google/chat/v1/membership.rb', line 64

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

  # Specifies the member's relationship with a space. Other membership states
  # might be supported in the future.
  module MembershipState
    # Default value. Don't use.
    MEMBERSHIP_STATE_UNSPECIFIED = 0

    # The user is added to the space, and can participate in the space.
    JOINED = 1

    # The user is invited to join the space, but hasn't joined it.
    INVITED = 2

    # The user doesn't belong to the space and doesn't have a pending
    # invitation to join the space.
    NOT_A_MEMBER = 3
  end

  # Represents a user's permitted actions in a Chat space. More enum values
  # might be added in the future.
  module MembershipRole
    # Default value. For {::Google::Apps::Chat::V1::Membership#member users}: they
    # aren't a member of the space, but can be invited. For
    # {::Google::Apps::Chat::V1::Membership#group_member Google Groups}: they're always
    #  assigned this role (other enum values might be used in the future).
    MEMBERSHIP_ROLE_UNSPECIFIED = 0

    # A member of the space. The user has basic permissions, like sending
    # messages to the space. In 1:1 and unnamed group conversations, everyone
    # has this role.
    ROLE_MEMBER = 1

    # A space manager. The user has all basic permissions plus administrative
    # permissions that let them manage the space, like adding or removing
    # members. Only supported in
    # {::Google::Apps::Chat::V1::Space::SpaceType SpaceType.SPACE}.
    ROLE_MANAGER = 2
  end
end

#role ⇒ ::Google::Apps::Chat::V1::Membership::MembershipRole

Returns Optional. User's role within a Chat space, which determines their permitted actions in the space.

This field can only be used as input in UpdateMembership.

Returns:



64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'proto_docs/google/chat/v1/membership.rb', line 64

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

  # Specifies the member's relationship with a space. Other membership states
  # might be supported in the future.
  module MembershipState
    # Default value. Don't use.
    MEMBERSHIP_STATE_UNSPECIFIED = 0

    # The user is added to the space, and can participate in the space.
    JOINED = 1

    # The user is invited to join the space, but hasn't joined it.
    INVITED = 2

    # The user doesn't belong to the space and doesn't have a pending
    # invitation to join the space.
    NOT_A_MEMBER = 3
  end

  # Represents a user's permitted actions in a Chat space. More enum values
  # might be added in the future.
  module MembershipRole
    # Default value. For {::Google::Apps::Chat::V1::Membership#member users}: they
    # aren't a member of the space, but can be invited. For
    # {::Google::Apps::Chat::V1::Membership#group_member Google Groups}: they're always
    #  assigned this role (other enum values might be used in the future).
    MEMBERSHIP_ROLE_UNSPECIFIED = 0

    # A member of the space. The user has basic permissions, like sending
    # messages to the space. In 1:1 and unnamed group conversations, everyone
    # has this role.
    ROLE_MEMBER = 1

    # A space manager. The user has all basic permissions plus administrative
    # permissions that let them manage the space, like adding or removing
    # members. Only supported in
    # {::Google::Apps::Chat::V1::Space::SpaceType SpaceType.SPACE}.
    ROLE_MANAGER = 2
  end
end

#state ⇒ ::Google::Apps::Chat::V1::Membership::MembershipState (readonly)

Returns Output only. State of the membership.

Returns:



64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'proto_docs/google/chat/v1/membership.rb', line 64

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

  # Specifies the member's relationship with a space. Other membership states
  # might be supported in the future.
  module MembershipState
    # Default value. Don't use.
    MEMBERSHIP_STATE_UNSPECIFIED = 0

    # The user is added to the space, and can participate in the space.
    JOINED = 1

    # The user is invited to join the space, but hasn't joined it.
    INVITED = 2

    # The user doesn't belong to the space and doesn't have a pending
    # invitation to join the space.
    NOT_A_MEMBER = 3
  end

  # Represents a user's permitted actions in a Chat space. More enum values
  # might be added in the future.
  module MembershipRole
    # Default value. For {::Google::Apps::Chat::V1::Membership#member users}: they
    # aren't a member of the space, but can be invited. For
    # {::Google::Apps::Chat::V1::Membership#group_member Google Groups}: they're always
    #  assigned this role (other enum values might be used in the future).
    MEMBERSHIP_ROLE_UNSPECIFIED = 0

    # A member of the space. The user has basic permissions, like sending
    # messages to the space. In 1:1 and unnamed group conversations, everyone
    # has this role.
    ROLE_MEMBER = 1

    # A space manager. The user has all basic permissions plus administrative
    # permissions that let them manage the space, like adding or removing
    # members. Only supported in
    # {::Google::Apps::Chat::V1::Space::SpaceType SpaceType.SPACE}.
    ROLE_MANAGER = 2
  end
end