MemberGroupClient

MemberGroupClient = MemberGroupClientBase & object

Type Declaration

create()

create(data: object): Promise<MemberGroup>

Parameters

Parameter	Type
data	{ communityRoleIds: CommunityRoleGuid[]; name: string; resourceId: string; resourceType: string; userIds: UserGuid[]; }
data.communityRoleIds	CommunityRoleGuid[]
data.name	string
data.resourceId	string
data.resourceType	string
data.userIds	UserGuid[]

Returns

Promise<MemberGroup>

getByName()

getByName(query: object): Promise<MemberGroup | undefined>

Parameters

Parameter	Type
query	{ name: string; resourceId: string; resourceType: string; }
query.name	string
query.resourceId	string
query.resourceType	string

Returns

Promise<MemberGroup | undefined>

list()

list(): Promise<MemberGroupShort[]>

Returns

Promise<MemberGroupShort[]>

listByResourceId()

listByResourceId(query: object): Promise<MemberGroup[]>

Parameters

Parameter	Type
query	{ resourceId: string; resourceType: string; }
query.resourceId	string
query.resourceType	string

Returns

Promise<MemberGroup[]>

listResourceIdsForUserId()

listResourceIdsForUserId(query: object, user: object): Promise<string[]>

Parameters

Parameter	Type
query	{ name: string; resourceType: string; }
query.name	string
query.resourceType	string
user	{ userId: UserGuid; }
user.userId	UserGuid

Returns

Promise<string[]>