chaterrortypes.h

Go to the documentation of this file.

/********************************************************************************************
* Twitch Broadcasting SDK
*
* This software is supplied under the terms of a license agreement with Twitch Interactive, Inc. and
* may not be copied or used except in accordance with the terms of that agreement
* Copyright (c) 2012-2016 Twitch Interactive, Inc.
*********************************************************************************************/

#pragma once

#include "twitchsdk/core/types/errortypes.h"

#include <vector>

const uint32_t TTV_MODULE_ID_TWITCH_CHAT = 1;


#define TTV_CHAT_ERROR_IDS\
    /* Warnings */\
    BEGIN_WARNING_IDS(TTV_WRN_CHAT_BEGIN_WARNINGS)\
    USE_TTV_WARNING_ID(TTV_WRN_CHAT_MESSAGE_SPAM_DISCARDED)         \
    END_WARNING_IDS(TTV_WRN_CHAT_END_WARNINGS)\
    \
    /* Errors */\
    BEGIN_ERROR_IDS(TTV_EC_CHAT_BEGIN_ERRORS)\
    USE_TTV_ERROR_ID(TTV_EC_CHAT_NO_HOSTS)              \
    USE_TTV_ERROR_ID(TTV_EC_CHAT_ALREADY_IN_CHANNEL)                \
    USE_TTV_ERROR_ID(TTV_EC_CHAT_LOST_CONNECTION)                   \
    USE_TTV_ERROR_ID(TTV_EC_CHAT_COULD_NOT_CONNECT)             \
    USE_TTV_ERROR_ID(TTV_EC_CHAT_NOT_IN_CHANNEL)                    \
    USE_TTV_ERROR_ID(TTV_EC_CHAT_INVALID_MESSAGE)                   \
    USE_TTV_ERROR_ID(TTV_EC_CHAT_TOO_MANY_REQUESTS)             \
    USE_TTV_ERROR_ID(TTV_EC_CHAT_LEAVING_CHANNEL)                   \
    USE_TTV_ERROR_ID(TTV_EC_CHAT_ANON_DENIED)                       \
    USE_TTV_ERROR_ID(TTV_EC_CHAT_RESTRICTED)                        \
    USE_TTV_ERROR_ID(TTV_EC_CHAT_EMOTICON_DATA_NOT_READY)           \
    USE_TTV_ERROR_ID(TTV_EC_CHAT_EMOTICON_DATA_DOWNLOADING)     \
    USE_TTV_ERROR_ID(TTV_EC_CHAT_EMOTICON_DATA_LOCKED)              \
    USE_TTV_ERROR_ID(TTV_EC_CHAT_EMOTICON_DOWNLOAD_FAILED)          \
    USE_TTV_ERROR_ID(TTV_EC_CHAT_INVALID_CHAT_THREAD_ID)            \
    USE_TTV_ERROR_ID(TTV_EC_CHAT_INVALID_CHAT_MESSAGE_ID)           \
    END_ERROR_IDS(TTV_EC_CHAT_END_ERRORS)\

#define USE_TTV_ERROR_ID(ec) ec,
#define USE_TTV_WARNING_ID(ec) ec,
#define USE_TTV_SUCCESS_ID(ec) ec = 0,
#define BEGIN_WARNING_IDS(ec) ec = CONSTRUCT_WARNING_ID_VALUE(TTV_MODULE_ID_TWITCH_CHAT, (1 << 12)),
#define END_WARNING_IDS(ec) ec,
#define BEGIN_ERROR_IDS(ec) ec = CONSTRUCT_ERROR_ID_VALUE(TTV_MODULE_ID_TWITCH_CHAT, 1),
#define END_ERROR_IDS(ec) ec

typedef enum
{
    TTV_CHAT_ERROR_IDS

} TTV_ChatErrorId;

#undef BEGIN_ERROR_IDS
#undef END_ERROR_IDS
#undef BEGIN_WARNING_IDS
#undef END_WARNING_IDS
#undef USE_TTV_SUCCESS_ID
#undef USE_TTV_WARNING_ID
#undef USE_TTV_ERROR_ID


namespace ttv
{
    namespace chat
    {
        const char* ChatErrorToString(TTV_ErrorCode ec);

        void GetChatErrorCodeValues(std::vector<EnumValue>& result);
        
        
        enum class GraphQLErrorCode
        {
            SUCCESS,                                        
            UNKNOWN,                                        
            AUTO_MOD_ENFORCEMENT_FAILED,                    
            CHANNEL_NOT_FOUND,                              
            DURATION_INVALID,                               
            EMOTE_ONLY_MODE_ENFORCEMENT_FAILED,             
            FORBIDDEN,                                      
            MAX_ROOMS_LIMIT_EXCEEDED,                       
            NAME_CONTAINS_INVALID_CHARACTERS,               
            NAME_INAPPROPRIATE,                             
            NAME_LENGTH_INVALID,                            
            R9K_MODE_ENFORCEMENT_FAILED,                    
            RATE_LIMIT_FAILED,                              
            ROOM_NOT_FOUND,                                 
            SLOW_MODE_DURATION_INVALID,                     
            SLOW_MODE_ENFORCEMENT_FAILED,                   
            SPAM_ENFORCEMENT_FAILED,                        
            TARGET_ALREADY_BANNED,                          
            TARGET_ALREADY_MOD,                             
            TARGET_IS_ADMIN,                                
            TARGET_IS_ANONYMOUS,                            
            TARGET_IS_BROADCASTER,                          
            TARGET_IS_CHAT_BANNED,                          
            TARGET_IS_GLOBAL_MOD,                           
            TARGET_IS_MOD,                                  
            TARGET_IS_SELF,                                 
            TARGET_IS_STAFF,                                
            TARGET_NOT_BANNED,                              
            TARGET_NOT_FOUND,                               
            TARGET_NOT_MOD,                                 
            TOPIC_INAPPROPRIATE,                            
            TOPIC_LENGTH_INVALID,                           
            USER_CHAT_BANNED,                               
            USER_CHAT_TIMED_OUT,                            
            USER_SUSPENDED,                                 
            ZALGO_ENFORCEMENT_FAILED,                       
        };
        
        struct SendRoomMessageError
        {
            SendRoomMessageError();
            
            GraphQLErrorCode code;                          
            uint32_t slowModeDurationSeconds;               
            uint32_t remainingDurationSeconds;              
        };
        
        struct CreateRoomError
        {
            CreateRoomError();
            
            GraphQLErrorCode code;                          
            uint32_t maxAllowedRooms;                       
            uint32_t minLength;                             
            uint32_t maxLength;                             
        };
        
        struct UpdateRoomError
        {
            UpdateRoomError();
            
            GraphQLErrorCode code;                          
            uint32_t minLength;                             
            uint32_t maxLength;                             
        };
        
        struct UpdateRoomModesError
        {
            UpdateRoomModesError();
            
            GraphQLErrorCode code;                          
            uint32_t minimumSlowModeDurationSeconds;        
            uint32_t maximumSlowModeDurationSeconds;        
        };
        
        struct BanUserError
        {
            BanUserError();
            
            GraphQLErrorCode code;                          
        };
        
        struct UnbanUserError
        {
            UnbanUserError();
            
            GraphQLErrorCode code;                          
        };
        
        struct ModUserError
        {
            ModUserError();
            
            GraphQLErrorCode code;                          
        };
        
        struct UnmodUserError
        {
            UnmodUserError();
            
            GraphQLErrorCode code;                          
        };
    }
}