Skip to main content

ODTranscriptCollector class

under construction

We are still working the API Reference! This page might be incomplete or doesn't contain all details!

Overview​

This is an Open Ticket transcript collector.

The only goal of this class is to collect & parse all messages from a ticket channel.

It also contains utility functions for counting all messages, calculating file sizes & more!

View Source

Properties​

    Methods​

    Other​

    Properties​

    Methods​

    constructor() function ➜ api.ODTranscriptCollector​

    (no description)

    View Parameters (2)

    View Source

    calculateFileSize() function ➜ {size:number, unit:"B"|"KB"|"MB"|"GB"|"TB"}​

    Calculate a human-readable file size. Used in transcripts.

    View Parameters (1)
    • bytes: number ➜ number - Parameter Description Lorem Ipsum.

    View Source

    collectAllMessages() function ➜ Promise​

    Collect all messages from a given ticket channel. It may not include all messages depending on the ratelimit.

    View Parameters (2)

    View Source

    convertMessagesToTranscriptData() function ➜ Promise​

    Convert an array of discord messages to an array of ODTranscriptMessageData's. This is used to simplify the process of the transcript compilers.

    View Parameters (1)
    • messages: array ➜ discord.Message[] - Parameter Description Lorem Ipsum.

    View Source

    countAllMessages() function ➜ Promise​

    Count all messages from a given ticket channel. It may not include all messages depending on the ratelimit.

    View Parameters (2)

    View Source

    Defaults​

    under construction

    We're still working on this part of the documentation!

    Examples​

    under construction

    We're still working on this part of the documentation!