Reference documentation and code samples for the Google Apps Chat V1 Client class Membership.
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.
Generated from protobuf message google.chat.v1.Membership
Namespace
Google \ Apps \ Chat \ V1Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ name
string
Identifier. Resource name of the membership, assigned by the server. Format: spaces/{space}/members/{member}
↳ state
int
Output only. State of the membership.
↳ role
int
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
.
↳ member
User
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
.
↳ group_member
Group
Optional. The Google Group the membership corresponds to. Reading or mutating memberships for Google Groups requires user authentication .
↳ create_time
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.
↳ delete_time
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.
getName
Identifier. Resource name of the membership, assigned by the server.
Format: spaces/{space}/members/{member}
string
setName
Identifier. Resource name of the membership, assigned by the server.
Format: spaces/{space}/members/{member}
var
string
$this
getState
Output only. State of the membership.
int
setState
Output only. State of the membership.
var
int
$this
getRole
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
.
int
setRole
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
.
var
int
$this
getMember
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
.
hasMember
setMember
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
.
$this
getGroupMember
Optional. The Google Group the membership corresponds to.
Reading or mutating memberships for Google Groups requires user authentication .
hasGroupMember
setGroupMember
Optional. The Google Group the membership corresponds to.
Reading or mutating memberships for Google Groups requires user authentication .
$this
getCreateTime
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.
hasCreateTime
clearCreateTime
setCreateTime
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.
$this
getDeleteTime
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.
hasDeleteTime
clearDeleteTime
setDeleteTime
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.
$this
getMemberType
string
