CommunityMemberRoleClient

CommunityMemberRoleClient = TypedEventEmitter<CommunityMemberRoleEvents> & object

Service client for managing role assignments on community members. Use this client to add roles to members, remove roles from members, list a member's roles, or set a member's primary displayed role.

This client manages the assignment of existing roles to members. To create, edit, or delete roles themselves, use CommunityRoleClient.

Access this client via rootServer.community.communityMemberRoles.

Type Declaration

add()

add(request: CommunityMemberRoleAddRequest): Promise<void>

Assigns a role to one or more community members.

Parameters

Parameter	Type	Description
request	CommunityMemberRoleAddRequest	The role ID and array of user IDs to assign the role to.

Returns

Promise<void>

A promise that resolves when the role has been assigned.

Throws

RootApiException with errorCode set to NotFound if the role or any user does not exist, or NoPermissionToAdd if missing required permissions or attempting to assign the @everyone role.

Example

import {
  CommunityMemberRoleAddRequest,
  CommunityRoleGuid,
  UserGuid,
  rootServer,
} from "@rootsdk/server-bot";

export async function addExample(
  communityRoleId: CommunityRoleGuid,
  userIds: UserGuid[],
): Promise<void> {
  try {
    // Set up the request
    const request: CommunityMemberRoleAddRequest = {
      communityRoleId: communityRoleId,
      userIds: userIds,
    };

    // Call the API
    await rootServer.community.communityMemberRoles.add(request);
  } catch (error) {
    // Detect error
    throw error;
  }
}

list()

list(request: CommunityMemberRoleListRequest): Promise<CommunityMemberRoleListResponse>

Lists all roles assigned to a specific community member.

Parameters

Parameter	Type	Description
request	CommunityMemberRoleListRequest	Identifies the member by user ID.

Returns

Promise<CommunityMemberRoleListResponse>

A promise that resolves to a CommunityMemberRoleListResponse containing the member's role IDs.

Throws

RootApiException with errorCode set to NoPermissionToRead if the caller is not a member of the community.

Example

import {
  CommunityMemberRole,
  CommunityMemberRoleListRequest,
  CommunityMemberRoleListResponse,
  UserGuid,
  rootServer,
} from "@rootsdk/server-bot";

export async function listExample(
  userId: UserGuid,
): Promise<CommunityMemberRoleListResponse> {
  try {
    // Set up the request
    const request: CommunityMemberRoleListRequest = {
      userId: userId,
    };
    // Call the API
    const communityMemberRoles: CommunityMemberRoleListResponse =
      await rootServer.community.communityMemberRoles.list(request);

    return communityMemberRoles;
  } catch (error) {
    // Detect error
    throw error;
  }
}

remove()

remove(request: CommunityMemberRoleRemoveRequest): Promise<void>

Removes a role from one or more community members.

Parameters

Parameter	Type	Description
request	CommunityMemberRoleRemoveRequest	The role ID and array of user IDs to remove the role from.

Returns

Promise<void>

A promise that resolves when the role has been removed.

Throws

RootApiException with errorCode set to NotFound if the role or any user does not exist, or NoPermissionToDelete if missing required permissions or attempting to remove the @everyone role.

Example

import {
  CommunityMemberRoleRemoveRequest,
  CommunityRoleGuid,
  UserGuid,
  rootServer,
} from "@rootsdk/server-bot";

export async function removeExample(
  communityRoleId: CommunityRoleGuid,
  userIds: UserGuid[],
): Promise<void> {
  try {
    // Set up the request
    const request: CommunityMemberRoleRemoveRequest = {
      communityRoleId: communityRoleId,
      userIds: userIds,
    };

    // Call the API
    await rootServer.community.communityMemberRoles.remove(request);
  } catch (error) {
    // Detect error
    throw error;
  }
}

setPrimary()

setPrimary(request: CommunityMemberRoleSetPrimaryRequest): Promise<void>

Sets a member's primary role, which determines their displayed role name and color.

Parameters

Parameter	Type	Description
request	CommunityMemberRoleSetPrimaryRequest	The user ID and the role ID to set as primary.

Returns

Promise<void>

A promise that resolves when the primary role has been set.

Throws

RootApiException with errorCode set to NotFound if the role does not exist, or NoPermissionToAdd if missing required permissions or attempting to set @everyone as primary.

Example

import {
  CommunityMemberRole,
  CommunityMemberRoleSetPrimaryRequest,
  CommunityRoleGuid,
  UserGuid,
  rootServer,
} from "@rootsdk/server-bot";

export async function setPrimaryExample(
  userId: UserGuid,
  communityRoleId: CommunityRoleGuid,
): Promise<void> {
  try {
    // Set up the request
    const request: CommunityMemberRoleSetPrimaryRequest = {
      userId: userId,
      communityRoleId: communityRoleId,
    };

    // Call the API
    await rootServer.community.communityMemberRoles.setPrimary(request);
  } catch (error) {
    // Detect error
    throw error;
  }
}