Converse converse.js

API Documentation

Namespace: headlines

headlines

The "headlines" namespace, which is used for headline-channels which are read-only channels containing messages of type "headline".

Source:

Methods

(static) get(jids, attrsopt, createopt) → {Promise.<_converse.HeadlinesFeed>}

Retrieves a headline-channel or all headline-channels.

Parameters:
Name Type Attributes Default Description
jids String | Array.<String>

e.g. 'buddy@example.com' or ['buddy1@example.com', 'buddy2@example.com']
attrs Object <optional>

Attributes to be set on the _converse.ChatBox model.
create Boolean <optional>
 false

Whether the chat should be created if it's not found.
Source:
Returns:
Type
Promise.<_converse.HeadlinesFeed>

(static) get(jids, attrsopt, createopt) → {Promise.<_converse.HeadlinesFeed>}

Retrieves a headline-channel or all headline-channels.

Parameters:
Name Type Attributes Default Description
jids String | Array.<String>

e.g. 'buddy@example.com' or ['buddy1@example.com', 'buddy2@example.com']
attrs Object <optional>

Attributes to be set on the _converse.ChatBox model.
create Boolean <optional>
 false

Whether the chat should be created if it's not found.
Source:
Returns:
Type
Promise.<_converse.HeadlinesFeed>

headlines

The "headlines" namespace, which is used for headline-channels which are read-only channels containing messages of type "headline".

Source:

Methods

(static) get(jids, attrsopt, createopt) → {Promise.<_converse.HeadlinesFeed>}

Retrieves a headline-channel or all headline-channels.

Parameters:
Name Type Attributes Default Description
jids String | Array.<String>

e.g. 'buddy@example.com' or ['buddy1@example.com', 'buddy2@example.com']
attrs Object <optional>

Attributes to be set on the _converse.ChatBox model.
create Boolean <optional>
 false

Whether the chat should be created if it's not found.
Source:
Returns:
Type
Promise.<_converse.HeadlinesFeed>

(static) get(jids, attrsopt, createopt) → {Promise.<_converse.HeadlinesFeed>}

Retrieves a headline-channel or all headline-channels.

Parameters:
Name Type Attributes Default Description
jids String | Array.<String>

e.g. 'buddy@example.com' or ['buddy1@example.com', 'buddy2@example.com']
attrs Object <optional>

Attributes to be set on the _converse.ChatBox model.
create Boolean <optional>
 false

Whether the chat should be created if it's not found.
Source:
Returns:
Type
Promise.<_converse.HeadlinesFeed>