Communities.Social.GroupMembers Entity

Represents the membership of a user in a social group. Entity: Cmm_Social_Group_Members (Introduced in version 20.1)

Default Visualization

Default Display Text Format:
{SocialGroup.Name}
Default Search Members:
SocialGroup.Name
Name Data Member:
SocialGroup.Name
Category: Definitions
Show in UI: CannotBeShown

Track Changes

Min level: 0 - Do not track changes
Max level: 4 - Track object attribute and blob changes

Aggregate

An aggregate is a cluster of domain objects that can be treated as a single unit.

Aggregate Parent:
Communities.Social.Groups
Aggregate Root:
Communities.Social.Groups

Attributes

Name	Type	Description
DisplayText	string	Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.
Id	guid
JoinTimeUtc	datetime	The exact server time (in UTC), when the user joined the group. `Required` `Default(NowUtc)` `Filter(ge;le)`
LastSeenTimeUtc	datetime nullable	The time (in UTC) until the group member caught up with the content in the corresponding group. null indicates that the group has no content or the member has never interacted with it. `Filter(ge;le)` `ReadOnly` `Introduced in version 25.1.1.12`
ObjectVersion	int32	The latest version of the extensible data object for the aggregate root for the time the object is loaded from the database. Can be used for optimistic locking.
Role	Role	Member role in a group. Defaults to member. `Required` `Default("M")` `Filter(eq)` `Introduced in version 23.1.1.95`

References

Name	Type	Description
SocialGroup	Groups	The group in which the user participates. `Required` `Filter(multi eq)` `Owner`
User	Users	The user, who is a member of the group. `Required` `Filter(multi eq)`

Attribute Details

DisplayText

Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.

Type: string
Category: Calculated Attributes
Supported Filters: NotFilterable
Supports Order By: ****
Show in UI: HiddenByDefault

Id

Type: guid
Indexed: True
Category: System
Supported Filters: Equals, EqualsIn
Default Value: NewGuid
Show in UI: ShownByDefault

JoinTimeUtc

The exact server time (in UTC), when the user joined the group. Required Default(NowUtc) Filter(ge;le)

Type: datetime
Category: System
Supported Filters: GreaterThanOrLessThan
Supports Order By: False
Default Value: CurrentDateTimeUtc
Show in UI: ShownByDefault

LastSeenTimeUtc

The time (in UTC) until the group member caught up with the content in the corresponding group. null indicates that the group has no content or the member has never interacted with it. Filter(ge;le) ReadOnly Introduced in version 25.1.1.12

Type: datetime nullable
Category: System
Supported Filters: GreaterThanOrLessThan
Supports Order By: False
Show in UI: HiddenByDefault

ObjectVersion

The latest version of the extensible data object for the aggregate root for the time the object is loaded from the database. Can be used for optimistic locking.

Type: int32
Category: Extensible Data Object
Supported Filters: NotFilterable
Supports Order By: ****
Show in UI: HiddenByDefault

Role

Member role in a group. Defaults to member. Required Default("M") Filter(eq) Introduced in version 23.1.1.95

Type: Role
Category: System
Allowed values for the Role(Communities.Social.GroupMembers.md#role) data attribute
Allowed Values (Communities.Social.GroupMembersRepository.Role Enum Members)

Value	Description
Member	Member. Stored as 'M'. Database Value: 'M' Model Value: 0 Domain API Value: 'Member'
Admin	Admin. Stored as 'A'. Database Value: 'A' Model Value: 1 Domain API Value: 'Admin'
Observer	Mostly, read-only permissions. Can like comments.. Stored as 'O'. Database Value: 'O' Model Value: 2 Domain API Value: 'Observer'

Supported Filters: Equals
Supports Order By: False
Default Value: Member
Show in UI: ShownByDefault

Reference Details

SocialGroup

The group in which the user participates. Required Filter(multi eq) Owner

Type: Groups
Category: System
Supported Filters: Equals, EqualsIn
Filterable Reference: True
Show in UI: ShownByDefault

User

The user, who is a member of the group. Required Filter(multi eq)

Type: Users
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: ShownByDefault

API Methods

Methods that can be invoked in public APIs.

GetAllowedCustomPropertyValues

Gets the allowed values for the specified custom property for this entity object. If supported the result is ordered by property value. Some property value sources do not support ordering - in that case the result is not ordered.
Return Type: Collection Of CustomPropertyValue
Declaring Type: EntityObject
Domain API Request: GET

Parameters

customPropertyCode
The code of the custom property
Type: string
search
The search text - searches by value or description. Can contain wildcard character %.
Type: string
Optional: True
Default Value: null
exactMatch
If true the search text should be equal to the property value
Type: boolean
Optional: True
Default Value: False
orderByDescription
If true the result is ordered by Description instead of Value. Note that ordering is not always possible.
Type: boolean
Optional: True
Default Value: False
top
The top clause - default is 10
Type: int32
Optional: True
Default Value: 10
skip
The skip clause - default is 0
Type: int32
Optional: True
Default Value: 0

CreateNotification

Create a notification immediately in a separate transaction, and send a real-time event to the user.
Return Type: void
Declaring Type: EntityObject
Domain API Request: POST