Interface Ribbon

interface Ribbon {
    err: any;
    error: any;
    kick: {
        reason: string;
    };
    nope: {
        reason: string;
    };
    notify:
        | string
        | {
            bgcolor?: `#${string}`;
            buttons?: {
                classes?: string;
                icon?: string;
                label: string;
            }[];
            classes?: string;
            color?: `#${string}`;
            fcolor?: `#${string}`;
            header?: string;
            icon?: string;
            id?: string;
            msg: string;
            subcolor?: `#${string}`;
            subicon?: string;
            timeout?: number;
        }
        | {
            msg: string;
            type:
                | "err"
                | "warn"
                | "ok"
                | "announce";
        }
        | {
            msg: string;
            timeout?: number;
            type: "deny";
        };
    packets: {
        packets: Buffer[];
    };
    ping: {
        recvid: number;
    };
    server.announcement: {
        msg: string;
        ts: number;
        type: string;
    };
    server.authorize: {
        maintenance: boolean;
        social: {
            notifications: Notification[];
            presences: {
                [userId: string]: {
                    detail: string;
                    invitable: boolean;
                    status: string;
                };
            };
            relationships: Types.Social.Relationship[];
            total_online: number;
        };
        success: boolean;
        worker: {
            flag: string;
            name: string;
        };
    };
    server.maintenance: {};
    server.migrate: {
        endpoint: string;
        flag: string;
        name: string;
    };
    server.migrated: {};
    session: {
        ribbonid: string;
        tokenid: string;
    };
}

Properties

err error kick nope notify packets ping server.announcement server.authorize server.maintenance server.migrate server.migrated session

Properties

err

err: any

error

error: any

kick

kick: {
    reason: string;
}

nope

nope: {
    reason: string;
}

notify

notify:
    | string
    | {
        bgcolor?: `#${string}`;
        buttons?: {
            classes?: string;
            icon?: string;
            label: string;
        }[];
        classes?: string;
        color?: `#${string}`;
        fcolor?: `#${string}`;
        header?: string;
        icon?: string;
        id?: string;
        msg: string;
        subcolor?: `#${string}`;
        subicon?: string;
        timeout?: number;
    }
    | {
        msg: string;
        type:
            | "err"
            | "warn"
            | "ok"
            | "announce";
    }
    | {
        msg: string;
        timeout?: number;
        type: "deny";
    }

packets

packets: {
    packets: Buffer[];
}

ping

ping: {
    recvid: number;
}

server.announcement

server.announcement: {
    msg: string;
    ts: number;
    type: string;
}

server.authorize

server.authorize: {
    maintenance: boolean;
    social: {
        notifications: Notification[];
        presences: {
            [userId: string]: {
                detail: string;
                invitable: boolean;
                status: string;
            };
        };
        relationships: Types.Social.Relationship[];
        total_online: number;
    };
    success: boolean;
    worker: {
        flag: string;
        name: string;
    };
}

server.maintenance

server.maintenance: {}

server.migrate

server.migrate: {
    endpoint: string;
    flag: string;
    name: string;
}

server.migrated

server.migrated: {}

session

session: {
    ribbonid: string;
    tokenid: string;
}

Settings

Member Visibility

On This Page

Properties