ShyyTAUI/src/lib/taDocs/2-stateManager-getQualifier.md

The stateManager.getQualifier() method

This documents the stateManager.getQualifier() method.

This method has input parameters. The function could easily be defined as:

function getQualifier(tournamentGuid: string, qualifierGuid: string): QualifierEvent | undefined {
    // backend logic
}

General usage:

const qualifier: QualifierEvent | undefined = taClient.stateManager.getQualifier(tournamentGuid, qualifierGuid);

This method will return either the QualifierEvent object or undefined. A QualifierEvent can be described by the following TypeScript Interface:

interface QualifierEvent {
    /**
     * @generated from protobuf field: string guid = 1;
     */
    guid: string;
    /**
     * @generated from protobuf field: string name = 2;
     */
    name: string;
    /**
     * @generated from protobuf field: bytes image = 3;
     */
    image: Uint8Array;
    /**
     * @generated from protobuf field: proto.discord.Channel info_channel = 4;
     */
    infoChannel?: {
        /**
         * @generated from protobuf field: string id = 1;
         */
        id: string;
        /**
         * @generated from protobuf field: string name = 2;
         */
        name: string;
    };
    /**
     * @generated from protobuf field: repeated proto.models.Map qualifier_maps = 5;
     */
    qualifierMaps: Map[];
    /**
     * @generated from protobuf field: proto.models.QualifierEvent.EventSettings flags = 6;
     */
    flags: QualifierEvent_EventSettings;
    /**
     * @generated from protobuf field: proto.models.QualifierEvent.LeaderboardSort sort = 7;
     */
    sort: QualifierEvent_LeaderboardSort;
}

For the definition of the QualifierEvent_EventSettings look at the Enums -> QualifierEvent_EventSettings and for the QualifierEvent_LeaderboardSort look at the Enums -> QualifierEvent_EventSettings page.

info

Example: A direct implementation example is not present, since this method is not used in ShyyTAUI.