logging_client.h

Go to the documentation of this file.

/*
** EPITECH PROJECT, XXXX
** NWP_myteams_XXXX
** File description:
** a file containing libs functions that should be called in myteams_cli
*/
 
#ifndef LIB_MYTEAMS_LOGGING_CLIENT_H
#define LIB_MYTEAMS_LOGGING_CLIENT_H
 
#include <time.h>
 
/*
** The functions that have event in their name are called when you receive
** something from the server, when it is not you who initiated the action.
**
** The other functions are called in response to one of your action.
**
** Ex: I received a private message (I did nothing to do so) so the function
** to call is one with event in it's name.
** Ex: I asked the server to join a team (I initiated this action) so the
** function to call is one that does not have event in it's name.
*/
 
/*
** To receive teams related events you MUST be logged in
*/
 
/*
** To receive team related events you MUST be subscribed to the team
** Ex: to receive client_event_thread_reply_received you must be subscribed to
** the team, that have the channel, that have the thread, that got the new reply
*/
 
/*
** To get team information or team modifications (list threads, create reply...)
** you MUST be subscribed to the team.
*/
 
int client_event_logged_in(char const *user_uuid, const char *user_name);
 
int client_event_logged_out(char const *user_uuid, const char *user_name);
 
int client_event_private_message_received(
    char const *user_uuid,
    char const *message_body);
 
int client_event_thread_reply_received(
    char const *team_uuid,
    char const *thread_uuid,
    char const *user_uuid,
    char const *reply_body);
 
int client_event_team_created(
    char const *team_uuid,
    char const *team_name,
    char const *team_description);
 
int client_event_channel_created(
    char const *channel_uuid,
    char const *channel_name,
    char const *channel_description);
 
int client_event_thread_created(
    char const *thread_uuid,
    char const *user_uuid,
    time_t thread_timestamp,
    char const *thread_title,
    char const *thread_body);
 
int client_print_users(
    char const *user_uuid,
    char const *user_name,
    int user_status);
 
int client_print_teams(
    char const *team_uuid,
    char const *team_name,
    char const *team_description);
 
int client_team_print_channels(
    char const *channel_uuid,
    char const *channel_name,
    char const *channel_description);
 
int client_channel_print_threads(
    char const *thread_uuid,
    char const *user_uuid,
    time_t thread_timestamp,
    char const *thread_title,
    char const *thread_body);
 
int client_thread_print_replies(
    char const *thread_uuid,
    char const *user_uuid,
    time_t reply_timestamp,
    char const *reply_body);
 
int client_private_message_print_messages(
    char const *sender_uuid,
    time_t message_timestamp,
    char const *message_body);
 
int client_error_unknown_team(char const *team_uuid);
 
int client_error_unknown_channel(char const *channel_uuid);
 
int client_error_unknown_thread(char const *thread_uuid);
 
int client_error_unknown_user(char const *user_uuid);
 
int client_error_unauthorized(void);
 
int client_error_already_exist(void);
 
int client_print_user(
    char const *user_uuid,
    char const *user_name,
    int user_status);
 
int client_print_team(
    char const *team_uuid,
    char const *team_name,
    char const *team_description);
 
int client_print_channel(
    char const *channel_uuid,
    char const *channel_name,
    char const *channel_description);
 
int client_print_thread(
    char const *thread_uuid,
    char const *user_uuid,
    time_t thread_timestamp,
    char const *thread_title,
    char const *thread_body);
 
int client_print_team_created(
    char const *team_uuid,
    char const *team_name,
    char const *team_description);
 
int client_print_channel_created(
    char const *channel_uuid,
    char const *channel_name,
    char const *channel_description);
 
int client_print_thread_created(
    char const *thread_uuid,
    char const *user_uuid,
    time_t thread_timestamp,
    char const *thread_title,
    char const *thread_body);
 
int client_print_reply_created(
    char const *thread_uuid,
    char const *user_uuid,
    time_t reply_timestamp,
    char const *reply_body);
 
int client_print_subscribed(char const *user_uuid, char const *team_uuid);
 
int client_print_unsubscribed(char const *user_uuid, char const *team_uuid);
 
#endif /* LIB_MYTEAMS_LOGGING_CLIENT_H */