subscribeContactToCategory( )

Developer Preview

Subscribes a contact to a specific forum category.

Description

By default a contact isn't subscribed to any forum categories.

By subscribing a contact to a category, the contact receives notifications for that category.

If contactId is not provided, it is implicitly resolved from the caller's context.

Admin Method

This function requires elevated permissions to run. This function is not universal and runs only on the backend.

Syntax

function subscribeContactToCategory(categoryId: string, options: SubscribeContactToCategoryOptions): Promise<void>

subscribeContactToCategory Parameters

NAME

TYPE

DESCRIPTION

categoryId

string

Category ID.

options

Optional

SubscribeContactToCategoryOptions

Options for subscribing the contact.

Returns

Return Type:

Promise<

void

Was this helpful?

subscribeContactToCategory example

Copy Code

1import { categories } from '@wix/wix-forum.v2';
2  
3 async function subscribeContactToCategory(categoryId, options) {
4   try {
5     const result = await categories.subscribeContactToCategory(categoryId, options);
6
7     return result;
8   } catch (error) {
9     console.error(error);
10     // Handle the error
11   }
12 }
13