ContentRenderer

ContentRenderer

The Content Renderer is in charge of transforming an ContentManager~Element into a channel-specific object.

Source:

Example

bp.renderers

Methods

(static) isRegistered(name) → {Boolean}

Returns whether or not a renderer is already registered

Source:
Parameters:
Name Type Description
name String

Unique name of the renderer (e.g. #text)

Returns:
Type:
Boolean

(static) register(name, rendererFn)

Registers a new renderer

Source:
Parameters:
Name Type Description
name String

Unique name of the renderer (e.g. #text).

rendererFn ContentRenderer.Renderer

The rendering function

(async, static) sendToUser(user, elementOrRenderer, data)

Proactively sends a user a message

Source:
Parameters:
Name Type Description
user string | object

id or a full user object

elementOrRenderer string

The name of the renderer to use OR an element id

data object

Additionnal data that will be passed to the renderer

Example
bp.renderers.sendToUser(event.user.id, '#!text-77734', { typingIndicators: false })

(static) unregister(name)

Removes a specific renderer if it exists

Source:
Parameters:
Name Type Description
name String

Unique name of the renderer (e.g. #text)

Type Definitions

.Renderer()

Source:
Example
bp.renderers.register('#text', data => ({ text: data.englishText }))