Skip to content

Commit 0047aba

Browse files
committed
*
1 parent 0b6ef06 commit 0047aba

File tree

2 files changed

+21
-4
lines changed

2 files changed

+21
-4
lines changed

api.md

Lines changed: 21 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -415,7 +415,7 @@ Returns a string path of where all of the cabals are stored on the hard drive.
415415
<a name="CabalDetails"></a>
416416

417417
## CabalDetails
418-
**Emits**: [<code>update</code>](#CabalDetails+event_update), [<code>init</code>](#CabalDetails+event_init), [<code>user-updated</code>](#CabalDetails+event_user-updated), [<code>new-channel</code>](#CabalDetails+event_new-channel), [<code>new-message</code>](#CabalDetails+event_new-message), <code>CabalDetails#event:publish-message</code>, [<code>publish-nick</code>](#CabalDetails+event_publish-nick), [<code>status-message</code>](#CabalDetails+event_status-message), [<code>topic</code>](#CabalDetails+event_topic), [<code>channel-focus</code>](#CabalDetails+event_channel-focus), [<code>channel-join</code>](#CabalDetails+event_channel-join), [<code>channel-leave</code>](#CabalDetails+event_channel-leave), [<code>cabal-focus</code>](#CabalDetails+event_cabal-focus), [<code>started-peering</code>](#CabalDetails+event_started-peering), <code>CabalDetails#event:stoppped-peering</code>, [<code>update</code>](#CabalDetails+event_update)
418+
**Emits**: [<code>update</code>](#CabalDetails+event_update), [<code>init</code>](#CabalDetails+event_init), [<code>user-updated</code>](#CabalDetails+event_user-updated), [<code>new-channel</code>](#CabalDetails+event_new-channel), [<code>new-message</code>](#CabalDetails+event_new-message), [<code>publish-message</code>](#CabalDetails+event_publish-message), [<code>publish-nick</code>](#CabalDetails+event_publish-nick), [<code>status-message</code>](#CabalDetails+event_status-message), [<code>topic</code>](#CabalDetails+event_topic), [<code>channel-focus</code>](#CabalDetails+event_channel-focus), [<code>channel-join</code>](#CabalDetails+event_channel-join), [<code>channel-leave</code>](#CabalDetails+event_channel-leave), [<code>cabal-focus</code>](#CabalDetails+event_cabal-focus), [<code>started-peering</code>](#CabalDetails+event_started-peering), [<code>stopped-peering</code>](#CabalDetails+event_stopped-peering)
419419

420420
* [CabalDetails](#CabalDetails)
421421
* [new CabalDetails(cabal, done)](#new_CabalDetails_new)
@@ -441,6 +441,7 @@ Returns a string path of where all of the cabals are stored on the hard drive.
441441
* ["user-updated"](#CabalDetails+event_user-updated)
442442
* ["new-channel"](#CabalDetails+event_new-channel)
443443
* ["new-message"](#CabalDetails+event_new-message)
444+
* ["publish-message"](#CabalDetails+event_publish-message)
444445
* ["publish-nick"](#CabalDetails+event_publish-nick)
445446
* ["status-message"](#CabalDetails+event_status-message)
446447
* ["topic"](#CabalDetails+event_topic)
@@ -727,11 +728,28 @@ Fires when a new message has been posted
727728
| author.key | <code>string</code> | Public key of the user |
728729
| author.local | <code>boolean</code> | True if user is the local user (i.e. at the keyboard and not someone else in the cabal) |
729730
| author.online | <code>boolean</code> | True if the user is currently online |
730-
| message | <code>object</code> | The message that was posted |
731+
| message | <code>object</code> | The message that was posted. See `cabal-core` for more complete message documentation. |
731732
| message.key | <code>string</code> | Public key of the user posting the message (again, it's a quirk) |
732733
| message.seq | <code>number</code> | Sequence number of the message in the user's append-only log |
733734
| message.value | <code>object</code> | Message content, see `cabal-core` documentation for more information. |
734-
| message.directMention | <code>object</code> | True if the message contained a direct mention |
735+
736+
737+
* * *
738+
739+
<a name="CabalDetails+event_publish-message"></a>
740+
741+
### "publish-message"
742+
Fires when the local user has published a new message
743+
744+
**Kind**: event emitted by [<code>CabalDetails</code>](#CabalDetails)
745+
**Properties**
746+
747+
| Name | Type | Description |
748+
| --- | --- | --- |
749+
| message | <code>object</code> | The message that was posted. See `cabal-core` for more complete message documentation. |
750+
| message.type | <code>string</code> | Message type that was posted, e.g. `chat/text` or `chat/emote` |
751+
| message.content | <code>string</code> | Message contents, e.g. channel and text if `chat/text` |
752+
| message.timestamp | <code>number</code> | The time the message was published |
735753

736754

737755
* * *

src/cabal-details.js

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,6 @@ class CabalDetails extends EventEmitter {
3232
* @fires CabalDetails#cabal-focus
3333
* @fires CabalDetails#started-peering
3434
* @fires CabalDetails#stopped-peering
35-
* @fires CabalDetails#update
3635
* @param {*} cabal
3736
* @param {function} done the function to be called after the cabal is initialized
3837
*/

0 commit comments

Comments
 (0)