Skip to main content

CommunityMemberInviteClient

CommunityMemberInviteClient = object

Service client for managing member invitations within a community. Member invitations allow existing community members to invite users to join the community with optional role assignments.

Access this client via rootServer.community.communityMemberInvites.

Methods​

delete()​

delete(request: CommunityMemberInviteDeleteRequest): Promise<void>

Revokes a pending member invitation.

Parameters​

ParameterTypeDescription
requestCommunityMemberInviteDeleteRequestIdentifies the invitation to delete by sender and invited user IDs.

Returns​

Promise<void>

A promise that resolves when the invitation has been deleted.

Throws​

RootApiException with errorCode set to NotFound if the invitation does not exist, or NoPermissionToDelete if missing required permissions.

Example​

import {
  CommunityMemberInvite,
  CommunityMemberInviteDeleteRequest,
  UserGuid,
  rootServer,
} from "@rootsdk/server-bot";

export async function deleteExample(
  invitedUserId: UserGuid,
  senderUserId: UserGuid,
): Promise<void> {
  try {
    // Set up the request
    const request: CommunityMemberInviteDeleteRequest = {
      invitedUserId: invitedUserId,
      senderUserId: senderUserId,
    };

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

get()​

get(request: CommunityMemberInviteGetRequest): Promise<CommunityMemberInvite>

Retrieves a specific member invitation by the sender and invited user combination.

Parameters​

ParameterTypeDescription
requestCommunityMemberInviteGetRequestIdentifies the invitation by sender and invited user IDs.

Returns​

Promise<CommunityMemberInvite>

A promise that resolves to the CommunityMemberInvite object.

Throws​

RootApiException with errorCode set to NotFound if the invitation does not exist, or NoPermissionToRead if missing required permissions.

Example​

import {
  CommunityMemberInvite,
  CommunityMemberInviteGetRequest,
  UserGuid,
  rootServer,
} from "@rootsdk/server-bot";

export async function getExample(
  invitedUserId: UserGuid,
  senderUserId: UserGuid,
): Promise<CommunityMemberInvite> {
  try {
    // Set up the request
    const request: CommunityMemberInviteGetRequest = {
      invitedUserId: invitedUserId,
      senderUserId: senderUserId,
    };

    // Call the API
    const communityMemberInvite =
      await rootServer.community.communityMemberInvites.get(request);

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

list()​

list(): Promise<CommunityMemberInvite[]>

Lists all pending member invitations for the community.

Returns​

Promise<CommunityMemberInvite[]>

A promise that resolves to an array of CommunityMemberInvite objects representing all pending invitations.

Throws​

RootApiException with errorCode set to NoPermissionToRead if missing required permissions.

Example​

import { CommunityMemberInvite, rootServer } from "@rootsdk/server-bot";

export async function listExample(): Promise<CommunityMemberInvite[]> {
  try {
    // Call the API
    const communityMemberInvites: CommunityMemberInvite[] =
      await rootServer.community.communityMemberInvites.list();

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