Skip to main content

CommunityAppLogClient

CommunityAppLogClient = object

Client for writing diagnostic logs visible to community members with the Manage Apps permission. Use this to record significant events, warnings, or errors from your app that those members may need to review.

This client is only available to apps. Bots cannot write community logs.

Access this client via rootServer.dataStore.logs.community.

Methods​

create()​

create(request: CommunityAppLogCreateRequest): Promise<CommunityAppLogCreateResponse>

Writes a log entry to the community's app log.

Parameters​

ParameterTypeDescription
requestCommunityAppLogCreateRequestThe log entry to create, including severity level and message.

Returns​

Promise<CommunityAppLogCreateResponse>

A promise that resolves to a CommunityAppLogCreateResponse containing the log entry ID.

Example​

import {
  CommunityAppLogType,
  CommunityAppLogCreateRequest,
  CommunityAppLogCreateResponse,
  rootServer,
} from "@rootsdk/server-bot";

export async function createExample(
  communityAppLogType: CommunityAppLogType,
  message: string,
): Promise<CommunityAppLogCreateResponse> {
  try {
    // Set up the request
    const request: CommunityAppLogCreateRequest = {
      communityAppLogType: communityAppLogType,
      message: message,
    };

    // Call the API
    const result: CommunityAppLogCreateResponse =
      await rootServer.dataStore.logs.community.create(request);

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