@mixer/interactive-node/lib/state/interfaces/IParticipant.d.ts

A NodeJS and Browser compatible client for mixer.com's interactive 2 Protocol

import { ETag } from './controls';
import { IMeta } from './controls/IMeta';
export interface IParticipantQuery {
    userIDs: number[];
}
export interface IParticipantQueryResult {
    users: Record<string, IParticipant>;
}
export interface IParticipantArray {
    participants: IParticipant[];
}
export interface IParticipant {
    /**
     * a unique string identifier for the user in this session. It’s
     * used for all participant identification internally, and
     * should be viewed as an opaque token.
     */
    sessionID: string;
    /**
     * This participant's Mixer UserId. Will be set to 0 if anonymous is true.
     */
    userID?: number;
    /**
     * This participant's Mixer Username.
     */
    username?: string;
    /**
     * This participant's Mixer level.
     */
    level?: number;
    /**
     * The unix milliseconds timestamp when the user last
     * interacted with the controls.
     */
    lastInputAt?: number;
    /**
     * The unix milliseconds timestamp when the user connected.
     */
    connectedAt?: number;
    /**
     * The disabled state of this participant, when disabled they cannot provide input.
     */
    disabled?: boolean;
    /**
     * The ID of the Group this user belongs to.
     */
    groupID?: string;
    /**
     * The Channel Groups the participant is in.
     */
    channelGroups: string[];
    meta?: IMeta;
    /**
     * True if this user has not signed in and is an anonymous user.
     */
    anonymous: boolean;
    /**
     * @deprecated etags are no longer used, you can always omit/ignore this.
     */
    etag?: ETag;
}