forums.join()

Join a forum.

For normal groups, only current group members can add/remove users, but anyone can join a forum.

Since forums are considered to be a superclass of groups, most group API functions will work on them, with some exceptions.

Definition

client.forums.join(
  groupId: string|Group,
):Promise<void,Error>

Parameters

ParameterTypeDescription
groupIdstring|GroupThe group ID or group model

Returns

An error will be thrown if the operation failed, otherwise the Promise will resolve.

Example

await client.forums.join(
  'some-group-id',
);
console.log('joined forum');