ChannelFileClient

ChannelFileClient = TypedEventEmitter<ChannelFileEvents> & object

Service client for managing files within channel directories. Files are stored in directories and linked to assets in the asset system.

Access this client via rootServer.community.channelFiles.

Type Declaration

create()

create(request: ChannelFileCreateRequest): Promise<ChannelFile>

Creates a new file entry in a directory. The file content must first be uploaded through the asset system to obtain an upload token.

Parameters

Parameter	Type	Description
request	ChannelFileCreateRequest	The file configuration including channel, directory, and upload token URI.

Returns

Promise<ChannelFile>

A promise that resolves to the created ChannelFile object.

Throws

RootApiException with errorCode set to NoPermissionToCreate if missing required permissions, or RequestValidationFailed if the request is invalid.

Example

import {
  ChannelFile,
  ChannelFileCreateRequest,
  ChannelGuid,
  DirectoryGuid,
  FileGuid,
  rootServer,
} from "@rootsdk/server-app";

export async function createExample(
  channelId: ChannelGuid,
  directoryId: DirectoryGuid,
  uploadToken: string,
): Promise<ChannelFile> {
  try {
    // Set up the request
    const request: ChannelFileCreateRequest = {
      directoryId: directoryId,
      channelId: channelId,
      uploadTokenUri: uploadToken,
    };

    // Call the API
    const file: ChannelFile =
      await rootServer.community.channelFiles.create(request);

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

Authorization

Declare the following permissions in your manifest:

"permissions": {
  "channel": {
    "createFile": true
  }
}

The community must also create channel access rules that give your code any needed visibility but don't deny these permissions via an overlay:

• createFile on the channel

delete()

delete(request: ChannelFileDeleteRequest): Promise<void>

Deletes a file.

Parameters

Parameter	Type	Description
request	ChannelFileDeleteRequest	Identifies the file to delete.

Returns

Promise<void>

A promise that resolves when the deletion completes.

Throws

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

Example

import {
  ChannelFile,
  ChannelFileDeleteRequest,
  ChannelGuid,
  DirectoryGuid,
  FileGuid,
  rootServer,
} from "@rootsdk/server-app";

export async function deleteExample(
  channelId: ChannelGuid,
  directoryId: DirectoryGuid,
  fileId: FileGuid,
): Promise<void> {
  try {
    // Set up the request
    const request: ChannelFileDeleteRequest = {
      id: fileId,
      directoryId: directoryId,
      channelId: channelId,
    };

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

Authorization

Declare the following permissions in your manifest:

"permissions": {
  "channel": {
    "manageFiles": true
  }
}

The community must also create channel access rules that give your code any needed visibility but don't deny these permissions via an overlay:

• manageFiles on the channel

edit()

edit(request: ChannelFileEditRequest): Promise<ChannelFileEditResponse>

Renames an existing file.

Parameters

Parameter	Type	Description
request	ChannelFileEditRequest	Identifies the file and specifies the new name.

Returns

Promise<ChannelFileEditResponse>

A promise that resolves to a ChannelFileEditResponse containing the updated file information.

Throws

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

Example

import {
  ChannelFile,
  ChannelFileEditRequest,
  ChannelFileEditResponse,
  ChannelGuid,
  DirectoryGuid,
  FileGuid,
  rootServer,
} from "@rootsdk/server-app";

export async function editExample(
  fileId: FileGuid,
  channelId: ChannelGuid,
  directoryId: DirectoryGuid,
  name: string,
): Promise<ChannelFileEditResponse> {
  try {
    // Set up the request
    const request: ChannelFileEditRequest = {
      id: fileId,
      channelId: channelId,
      directoryId: directoryId,
      name: "MyNewFileName",
    };

    // Call the API
    const file: ChannelFileEditResponse =
      await rootServer.community.channelFiles.edit(request);

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

Authorization

Declare the following permissions in your manifest:

"permissions": {
  "channel": {
    "manageFiles": true
  }
}

The community must also create channel access rules that give your code any needed visibility but don't deny these permissions via an overlay:

• manageFiles on the channel

get()

get(request: ChannelFileGetRequest): Promise<ChannelFile>

Retrieves a single file by its ID.

Parameters

Parameter	Type	Description
request	ChannelFileGetRequest	Identifies the channel, directory, and file to retrieve.

Returns

Promise<ChannelFile>

A promise that resolves to the ChannelFile object.

Throws

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

Example

import {
  ChannelFile,
  ChannelFileGetRequest,
  ChannelGuid,
  DirectoryGuid,
  FileGuid,
  rootServer,
} from "@rootsdk/server-app";

export async function getExample(
  fileId: FileGuid,
  channelId: ChannelGuid,
  directoryId: DirectoryGuid,
): Promise<ChannelFile> {
  try {
    // Set up the request
    const request: ChannelFileGetRequest = {
      id: fileId,
      channelId: channelId,
      directoryId: directoryId,
    };

    // Call the API
    const response: ChannelFile =
      await rootServer.community.channelFiles.get(request);

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

Authorization

Declare the following permissions in your manifest:

"permissions": {
  "channel": {
    "viewFile": true
  }
}

The community must also create channel access rules that give your code any needed visibility but don't deny these permissions via an overlay:

• viewFile on the channel

list()

list(request: ChannelFileListRequest): Promise<ChannelFile[]>

Lists all files in a specific directory.

Parameters

Parameter	Type	Description
request	ChannelFileListRequest	Identifies the channel and directory to list files from.

Returns

Promise<ChannelFile[]>

A promise that resolves to an array of ChannelFile objects.

Throws

RootApiException with errorCode set to NoPermissionToRead if missing required permissions.

Example

import {
  ChannelFile,
  ChannelFileListRequest,
  ChannelGuid,
  DirectoryGuid,
  rootServer,
} from "@rootsdk/server-app";

export async function listExample(
  channelId: ChannelGuid,
  directoryId: DirectoryGuid,
): Promise<ChannelFile[]> {
  try {
    // Set up the request
    const request: ChannelFileListRequest = {
      channelId: channelId,
      directoryId: directoryId,
    };

    // Call the API
    const files: ChannelFile[] =
      await rootServer.community.channelFiles.list(request);

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

Authorization

Declare the following permissions in your manifest:

"permissions": {
  "channel": {
    "viewFile": true
  }
}

The community must also create channel access rules that give your code any needed visibility but don't deny these permissions via an overlay:

• viewFile on the channel

move()

move(request: ChannelFileMoveRequest): Promise<ChannelFileMoveResponse>

Moves a file to a different directory.

Parameters

Parameter	Type	Description
request	ChannelFileMoveRequest	Identifies the file and specifies the old and new directories.

Returns

Promise<ChannelFileMoveResponse>

A promise that resolves to a ChannelFileMoveResponse containing the move result.

Throws

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

Example

import {
  ChannelFile,
  ChannelFileMoveRequest,
  ChannelFileMoveResponse,
  ChannelGuid,
  DirectoryGuid,
  FileGuid,
  rootServer,
} from "@rootsdk/server-app";

export async function moveExample(
  fileId: FileGuid,
  channelId: ChannelGuid,
  oldDirectoryId: DirectoryGuid,
  newDirectoryId: DirectoryGuid,
): Promise<ChannelFileMoveResponse> {
  try {
    // Set up the request
    const request: ChannelFileMoveRequest = {
      id: fileId,
      channelId: channelId,
      oldDirectoryId: oldDirectoryId,
      newDirectoryId: newDirectoryId,
    };

    // Call the API
    const file: ChannelFileMoveResponse =
      await rootServer.community.channelFiles.move(request);

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

Authorization

Declare the following permissions in your manifest:

"permissions": {
  "channel": {
    "manageFiles": true
  }
}

The community must also create channel access rules that give your code any needed visibility but don't deny these permissions via an overlay:

• manageFiles on the channel

search()

search(request: ChannelFileSearchRequest): Promise<ChannelFile[]>

Searches for files by name within a single channel. Supports pagination using lastFileId.

Parameters

Parameter	Type	Description
request	ChannelFileSearchRequest	The search criteria including channel ID and search string.

Returns

Promise<ChannelFile[]>

A promise that resolves to an array of matching ChannelFile objects.

Throws

RootApiException with errorCode set to NoPermissionToRead if missing required permissions.

Example

import {
  ChannelFile,
  ChannelFileSearchRequest,
  ChannelGuid,
  DirectoryGuid,
  rootServer,
} from "@rootsdk/server-app";

export async function searchExample(
  channelId: ChannelGuid,
  search: string,
): Promise<ChannelFile[]> {
  try {
    // Set up the request
    const request: ChannelFileSearchRequest = {
      channelId: channelId,
      search: search,
      lastFileId: undefined,
    };

    // Call the API
    const response: ChannelFile[] =
      await rootServer.community.channelFiles.search(request);

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

Authorization

Declare the following permissions in your manifest:

"permissions": {
  "channel": {
    "viewFile": true
  }
}

The community must also create channel access rules that give your code any needed visibility but don't deny these permissions via an overlay:

• viewFile on the channel

searchCommunity()

searchCommunity(request: ChannelFileSearchCommunityRequest): Promise<ChannelFileSearchCommunityResponse>

Searches for files by name across multiple channels.

Parameters

Parameter	Type	Description
request	ChannelFileSearchCommunityRequest	The search criteria including an array of channel IDs and search string.

Returns

Promise<ChannelFileSearchCommunityResponse>

A promise that resolves to a ChannelFileSearchCommunityResponse containing results grouped by channel.

Throws

RootApiException with errorCode set to NoPermissionToRead if missing required permissions for any specified channel.

Example

import {
  ChannelFile,
  ChannelFileSearchCommunityRequest,
  ChannelFileSearchCommunityResponse,
  ChannelGuid,
  DirectoryGuid,
  rootServer,
} from "@rootsdk/server-app";

export async function searchCommunityExample(
  channelIds: ChannelGuid[],
  search: string,
): Promise<ChannelFileSearchCommunityResponse> {
  try {
    // Set up the request
    const request: ChannelFileSearchCommunityRequest = {
      channelIds: channelIds,
      search: search,
    };

    // Call the API
    const response: ChannelFileSearchCommunityResponse =
      await rootServer.community.channelFiles.searchCommunity(request);

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

Authorization

Declare the following permissions in your manifest:

"permissions": {
  "channel": {
    "viewFile": true
  }
}

The community must also create channel access rules that give your code any needed visibility but don't deny these permissions via an overlay:

• viewFile on the channel