Skip to main content

MemberGroup

MemberGroup: object

Type declaration

communityId

communityId: CommunityGuid

communityRoleIds

communityRoleIds: CommunityRoleGuid[]

id

id: CustomMemberGroupGuid

memberUserIds

memberUserIds: UserGuid[]

memberUserIdsAsSet

memberUserIdsAsSet: Set<UserGuid>

name

name: string

resourceId

resourceId: string

resourceType

resourceType: string

userIds

userIds: UserGuid[]

addCommunityRole()

Parameters

ParameterType
communityRoleIdstring

Returns

Promise<void>

addCommunityRoles()

Parameters

ParameterType
communityRoleIdsstring[]

Returns

Promise<void>

addUser()

Parameters

ParameterType
userIdstring

Returns

Promise<void>

addUsers()

Parameters

ParameterType
userIdsstring[]

Returns

Promise<void>

isMember()

Parameters

ParameterType
user{ userId: string; }
user.userIdstring

Returns

Promise<boolean>

removeCommunityRole()

Parameters

ParameterType
communityRoleIdstring

Returns

Promise<void>

removeCommunityRoles()

Parameters

ParameterType
communityRoleIdsstring[]

Returns

Promise<void>

removeUser()

Parameters

ParameterType
userIdstring

Returns

Promise<void>

removeUsers()

Parameters

ParameterType
userIdsstring[]

Returns

Promise<void>

update()

Parameters

ParameterType
data{ communityRoleIds: string[]; userIds: string[]; }
data.communityRoleIdsstring[]
data.userIdsstring[]

Returns

Promise<void>