TeamTalk 5 C-API DLL: Server Notification Callbacks

TeamTalk 5 C-API DLL Version 5.18A

Loading...
Searching...
No Matches
Typedefs | Functions
Server Notification Callbacks

Notification events for server changes. More...

## Typedefs

typedef void | UserConnectedCallback(IN TTSInstance *lpTTSInstance, IN VOID *lpUserData, IN const User *lpUser)
| Callback when a new user is connecting to the server.
typedef void | UserLoggedInCallback(IN TTSInstance *lpTTSInstance, IN VOID *lpUserData, IN const User *lpUser)
| Callback when a user has logged in.
typedef void | UserLoggedOutCallback(IN TTSInstance *lpTTSInstance, IN VOID *lpUserData, IN const User *lpUser)
| Callback when a user has logged out.
typedef void | UserDisconnectedCallback(IN TTSInstance *lpTTSInstance, IN VOID *lpUserData, IN const User *lpUser)
| Callback when user has disconnected.
typedef void | UserTimedoutCallback(IN TTSInstance *lpTTSInstance, IN VOID *lpUserData, IN const User *lpUser)
| Callback when a user's connection has timed out.
typedef void | UserKickedCallback(IN TTSInstance *lpTTSInstance, IN VOID *lpUserData, IN const User *lpKicker, IN const User *lpKickee, IN const Channel *lpChannel)
| Callback when a user has been kicked.
typedef void | UserBannedCallback(IN TTSInstance *lpTTSInstance, IN VOID *lpUserData, IN const User *lpBanner, IN const User *lpBanee, IN const Channel *lpChannel)
| Callback when a user has been banned.
typedef void | UserUnbannedCallback(IN TTSInstance *lpTTSInstance, IN VOID *lpUserData, IN const User *lpUnbanner, IN const TTCHAR *szIPAddress)
| Callback when a ban is removed.
typedef void | UserUpdatedCallback(IN TTSInstance *lpTTSInstance, IN VOID *lpUserData, IN const User *lpUser)
| Callback when a user's properties are being updated.
typedef void | UserJoinedChannelCallback(IN TTSInstance *lpTTSInstance, IN VOID *lpUserData, IN const User *lpUser, IN const Channel *lpChannel)
| Callback when a user has joined a channel.
typedef void | UserLeftChannelCallback(IN TTSInstance *lpTTSInstance, IN VOID *lpUserData, IN const User *lpUser, IN const Channel *lpChannel)
| Callback when a user has left a channel.
typedef void | UserMovedCallback(IN TTSInstance *lpTTSInstance, IN VOID *lpUserData, IN const User *lpMover, IN const User *lpMovee)
| Callback when a user has been moved.
typedef void | UserTextMessageCallback(IN TTSInstance *lpTTSInstance, IN VOID *lpUserData, IN const User *lpUser, IN const TextMessage *lpTextMessage)
| Callback when a user is sending a text message.
typedef void | ChannelCreatedCallback(IN TTSInstance *lpTTSInstance, IN VOID *lpUserData, IN const Channel *lpChannel, IN const User *lpUser)
| Callback when a new channel has been created.
typedef void | ChannelUpdatedCallback(IN TTSInstance *lpTTSInstance, IN VOID *lpUserData, IN const Channel *lpChannel, IN const User *lpUser)
| Callback when a channel has been updated.
typedef void | ChannelRemovedCallback(IN TTSInstance *lpTTSInstance, IN VOID *lpUserData, IN const Channel *lpChannel, IN const User *lpUser)
| Callback when channel has been removed.
typedef void | FileUploadedCallback(IN TTSInstance *lpTTSInstance, IN VOID *lpUserData, IN const RemoteFile *lpRemoteFile, IN const User *lpUser)
| Callback when a new file has been uploaded to a channel.
typedef void | FileDownloadedCallback(IN TTSInstance *lpTTSInstance, IN VOID *lpUserData, IN const RemoteFile *lpRemoteFile, IN const User *lpUser)
| Callback when a user has downloaded a file.
typedef void | FileDeletedCallback(IN TTSInstance *lpTTSInstance, IN VOID *lpUserData, IN const RemoteFile *lpRemoteFile, IN const User *lpUser)
| Callback when a user has deleted a file.
typedef void | ServerUpdatedCallback(IN TTSInstance *lpTTSInstance, IN VOID *lpUserData, IN const ServerProperties *lpServerProperties, IN const User *lpUser)
| Callback when a user has updated the server properties.
typedef void | SaveServerConfigCallback(IN TTSInstance *lpTTSInstance, IN VOID *lpUserData, IN const User *lpUser)
| Callback when a user has reguested to save the server configuration.

## Functions

TEAMTALKDLL_API TTBOOL | TTS_RegisterUserConnectedCallback (IN TTSInstance *lpTTSInstance, IN UserConnectedCallback *lpCallback, IN VOID *lpUserData, IN TTBOOL bEnable)
| Register a callback when a user connects to the server.
TEAMTALKDLL_API TTBOOL | TTS_RegisterUserLoggedInCallback (IN TTSInstance *lpTTSInstance, IN UserLoggedInCallback *lpCallback, IN VOID *lpUserData, IN TTBOOL bEnable)
| Register a callback when a user logs on to the server.
TEAMTALKDLL_API TTBOOL | TTS_RegisterUserLoggedOutCallback (IN TTSInstance *lpTTSInstance, IN UserLoggedOutCallback *lpCallback, IN VOID *lpUserData, IN TTBOOL bEnable)
| Register a callback when a user logs out of the server.
TEAMTALKDLL_API TTBOOL | TTS_RegisterUserDisconnectedCallback (IN TTSInstance *lpTTSInstance, IN UserDisconnectedCallback *lpCallback, IN VOID *lpUserData, IN TTBOOL bEnable)
| Register a callback when a user disconnects from the server.
TEAMTALKDLL_API TTBOOL | TTS_RegisterUserTimedoutCallback (IN TTSInstance *lpTTSInstance, IN UserTimedoutCallback *lpCallback, IN VOID *lpUserData, IN TTBOOL bEnable)
| Register a callback when a user is dropped because of inactivity.
TEAMTALKDLL_API TTBOOL | TTS_RegisterUserKickedCallback (IN TTSInstance *lpTTSInstance, IN UserKickedCallback *lpCallback, IN VOID *lpUserData, IN TTBOOL bEnable)
| Register a callback when a user is kicked from the server.
TEAMTALKDLL_API TTBOOL | TTS_RegisterUserBannedCallback (IN TTSInstance *lpTTSInstance, IN UserBannedCallback *lpCallback, IN VOID *lpUserData, IN TTBOOL bEnable)
| Register a callback when a user is banned from the server.
TEAMTALKDLL_API TTBOOL | TTS_RegisterUserUnbannedCallback (IN TTSInstance *lpTTSInstance, IN UserUnbannedCallback *lpCallback, IN VOID *lpUserData, IN TTBOOL bEnable)
| Register a callback when an IP-address is unbanned from the server.
TEAMTALKDLL_API TTBOOL | TTS_RegisterUserUpdatedCallback (IN TTSInstance *lpTTSInstance, IN UserUpdatedCallback *lpCallback, IN VOID *lpUserData, IN TTBOOL bEnable)
| Register a callback when an user's properties are updated.
TEAMTALKDLL_API TTBOOL | TTS_RegisterUserJoinedChannelCallback (IN TTSInstance *lpTTSInstance, IN UserJoinedChannelCallback *lpCallback, IN VOID *lpUserData, IN TTBOOL bEnable)
| Register a callback when an user joins a channel.
TEAMTALKDLL_API TTBOOL | TTS_RegisterUserLeftChannelCallback (IN TTSInstance *lpTTSInstance, IN UserLeftChannelCallback *lpCallback, IN VOID *lpUserData, IN TTBOOL bEnable)
| Register a callback when an user leaves a channel.
TEAMTALKDLL_API TTBOOL | TTS_RegisterUserMovedCallback (IN TTSInstance *lpTTSInstance, IN UserMovedCallback *lpCallback, IN VOID *lpUserData, IN TTBOOL bEnable)
| Register a callback when a user is moved.
TEAMTALKDLL_API TTBOOL | TTS_RegisterUserTextMessageCallback (IN TTSInstance *lpTTSInstance, IN UserTextMessageCallback *lpCallback, IN VOID *lpUserData, IN TTBOOL bEnable)
| Register a callback when a user send a text message.
TEAMTALKDLL_API TTBOOL | TTS_RegisterChannelCreatedCallback (IN TTSInstance *lpTTSInstance, IN ChannelCreatedCallback *lpCallback, IN VOID *lpUserData, IN TTBOOL bEnable)
| Register a callback when a channel is created.
TEAMTALKDLL_API TTBOOL | TTS_RegisterChannelUpdatedCallback (IN TTSInstance *lpTTSInstance, IN ChannelUpdatedCallback *lpCallback, IN VOID *lpUserData, IN TTBOOL bEnable)
| Register a callback when a channel is updated.
TEAMTALKDLL_API TTBOOL | TTS_RegisterChannelRemovedCallback (IN TTSInstance *lpTTSInstance, IN ChannelRemovedCallback *lpCallback, IN VOID *lpUserData, IN TTBOOL bEnable)
| Register a callback when a channel is removed.
TEAMTALKDLL_API TTBOOL | TTS_RegisterFileUploadedCallback (IN TTSInstance *lpTTSInstance, IN FileUploadedCallback *lpCallback, IN VOID *lpUserData, IN TTBOOL bEnable)
| Register a callback when a file is uploaded.
TEAMTALKDLL_API TTBOOL | TTS_RegisterFileDownloadedCallback (IN TTSInstance *lpTTSInstance, IN FileDownloadedCallback *lpCallback, IN VOID *lpUserData, IN TTBOOL bEnable)
| Register a callback when a file is downloaded.
TEAMTALKDLL_API TTBOOL | TTS_RegisterFileDeletedCallback (IN TTSInstance *lpTTSInstance, IN FileDeletedCallback *lpCallback, IN VOID *lpUserData, IN TTBOOL bEnable)
| Register a callback when a file is deleted.
TEAMTALKDLL_API TTBOOL | TTS_RegisterServerUpdatedCallback (IN TTSInstance *lpTTSInstance, IN ServerUpdatedCallback *lpCallback, IN VOID *lpUserData, IN TTBOOL bEnable)
| Register a callback when a server's properties has been updated.
TEAMTALKDLL_API TTBOOL | TTS_RegisterSaveServerConfigCallback (IN TTSInstance *lpTTSInstance, IN SaveServerConfigCallback *lpCallback, IN VOID *lpUserData, IN TTBOOL bEnable)
| Register a callback when a user requests the server to save its configuration.

## Detailed Description

Notification events for server changes.

Callbacks of this type are mainly meant for logging so it's possible to see what is going on the server. Examples of logging events are when a user is dropped due to connection timeout.

## Typedef Documentation

## ◆ UserConnectedCallback

typedef void UserConnectedCallback(IN TTSInstance *lpTTSInstance, IN VOID *lpUserData, IN const User *lpUser)

Callback when a new user is connecting to the server.

Register using TTS_RegisterUserConnectedCallback().

Parameters

  lpTTSInstance | The server instance where the event is occurring.
  lpUserData | The user data supplied to register-callback function.
  lpUser | The user properties gathered so far.

Definition at line 203 of file TeamTalkSrv.h.

## ◆ UserLoggedInCallback

typedef void UserLoggedInCallback(IN TTSInstance *lpTTSInstance, IN VOID *lpUserData, IN const User *lpUser)

Callback when a user has logged in.

This callback occurs in the context of TT_DoLogin() and if UserLoginCallback returned CMDERR_SUCCESS.

Register using TTS_RegisterUserLoggedInCallback().

Parameters

  lpTTSInstance | The server instance where the event is occurring.
  lpUserData | The user data supplied to register-callback function.
  lpUser | The user properties of the user who logged in.

Definition at line 216 of file TeamTalkSrv.h.

## ◆ UserLoggedOutCallback

typedef void UserLoggedOutCallback(IN TTSInstance *lpTTSInstance, IN VOID *lpUserData, IN const User *lpUser)

Callback when a user has logged out.

Register using TTS_RegisterUserLoggedInCallback().

Parameters

  lpTTSInstance | The server instance where the event is occurring.
  lpUserData | The user data supplied to register-callback function.
  lpUser | The properties of the user.

Definition at line 226 of file TeamTalkSrv.h.

## ◆ UserDisconnectedCallback

typedef void UserDisconnectedCallback(IN TTSInstance *lpTTSInstance, IN VOID *lpUserData, IN const User *lpUser)

Callback when user has disconnected.

Register using TTS_RegisterUserDisconnectedCallback().

Parameters

  lpTTSInstance | The server instance where the event is occurring.
  lpUserData | The user data supplied to register-callback function.
  lpUser | The properties of the user.

Definition at line 236 of file TeamTalkSrv.h.

## ◆ UserTimedoutCallback

typedef void UserTimedoutCallback(IN TTSInstance *lpTTSInstance, IN VOID *lpUserData, IN const User *lpUser)

Callback when a user's connection has timed out.

Register using TTS_RegisterUserTimedoutCallback().

Parameters

  lpTTSInstance | The server instance where the event is occurring.
  lpUserData | The user data supplied to register-callback function.
  lpUser | The properties of the user.

Definition at line 246 of file TeamTalkSrv.h.

## ◆ UserKickedCallback

typedef void UserKickedCallback(IN TTSInstance *lpTTSInstance, IN VOID *lpUserData, IN const User *lpKicker, IN const User *lpKickee, IN const Channel *lpChannel)

Callback when a user has been kicked.

Register using TTS_RegisterUserKickedCallback().

Parameters

  lpTTSInstance | The server instance where the event is occurring.
  lpUserData | The user data supplied to register-callback function.
  lpKicker | The user who had initiated the kick. This can be 0.
  lpKickee | The user who has been kicked.
  lpChannel | The channel where the user is kicked from. The can be 0.

Definition at line 258 of file TeamTalkSrv.h.

## ◆ UserBannedCallback

typedef void UserBannedCallback(IN TTSInstance *lpTTSInstance, IN VOID *lpUserData, IN const User *lpBanner, IN const User *lpBanee, IN const Channel *lpChannel)

Callback when a user has been banned.

Register using TTS_RegisterUserBannedCallback().

Parameters

  lpTTSInstance | The server instance where the event is occurring.
  lpUserData | The user data supplied to register-callback function.
  lpBanner | The user who had initiated the ban. This can be 0.
  lpBanee | The user who has been banned. This may only contain an IP-address.
  lpChannel | The channel where the user is banned from. The can be 0.

Definition at line 272 of file TeamTalkSrv.h.

## ◆ UserUnbannedCallback

typedef void UserUnbannedCallback(IN TTSInstance *lpTTSInstance, IN VOID *lpUserData, IN const User *lpUnbanner, IN const TTCHAR *szIPAddress)

Callback when a ban is removed.

This callback occurs in the contect of TT_DoUnBanUser().

Register using TTS_RegisterUserUnbannedCallback().

Parameters

  lpTTSInstance | The server instance where the event is occurring.
  lpUserData | The user data supplied to register-callback function.
  lpUnbanner | The user removing the ban.
  szIPAddress | The IP-address which is unbanned.

Definition at line 286 of file TeamTalkSrv.h.

## ◆ UserUpdatedCallback

typedef void UserUpdatedCallback(IN TTSInstance *lpTTSInstance, IN VOID *lpUserData, IN const User *lpUser)

Callback when a user's properties are being updated.

Register using TTS_RegisterUserUpdatedCallback().

Parameters

  lpTTSInstance | The server instance where the event is occurring.
  lpUserData | The user data supplied to register-callback function.
  lpUser | The properties of the user.

Definition at line 297 of file TeamTalkSrv.h.

## ◆ UserJoinedChannelCallback

typedef void UserJoinedChannelCallback(IN TTSInstance *lpTTSInstance, IN VOID *lpUserData, IN const User *lpUser, IN const Channel *lpChannel)

Callback when a user has joined a channel.

Register using TTS_RegisterUserJoinedChannelCallback().

Parameters

  lpTTSInstance | The server instance where the event is occurring.
  lpUserData | The user data supplied to register-callback function.
  lpUser | The properties of the user.
  lpChannel | The properties of the channel being joined.

Definition at line 308 of file TeamTalkSrv.h.

## ◆ UserLeftChannelCallback

typedef void UserLeftChannelCallback(IN TTSInstance *lpTTSInstance, IN VOID *lpUserData, IN const User *lpUser, IN const Channel *lpChannel)

Callback when a user has left a channel.

Register using TTS_RegisterUserLeftChannelCallback().

Parameters

  lpTTSInstance | The server instance where the event is occurring.
  lpUserData | The user data supplied to register-callback function.
  lpUser | The properties of the user.
  lpChannel | The properties of the channel being left.

Definition at line 320 of file TeamTalkSrv.h.

## ◆ UserMovedCallback

typedef void UserMovedCallback(IN TTSInstance *lpTTSInstance, IN VOID *lpUserData, IN const User *lpMover, IN const User *lpMovee)

Callback when a user has been moved.

This callback occurs in the context of TT_DoMoveUser().

Register using TTS_RegisterUserMovedCallback().

Parameters

  lpTTSInstance | The server instance where the event is occurring.
  lpUserData | The user data supplied to register-callback function.
  lpMover | The user who initiated the move.
  lpMovee | The user who has been moved.

Definition at line 334 of file TeamTalkSrv.h.

## ◆ UserTextMessageCallback

typedef void UserTextMessageCallback(IN TTSInstance *lpTTSInstance, IN VOID *lpUserData, IN const User *lpUser, IN const TextMessage *lpTextMessage)

Callback when a user is sending a text message.

This callback occurs in the context of TT_DoTextMessage().

Register using TTS_RegisterUserTextMessageCallback().

Parameters

  lpTTSInstance | The server instance where the event is occurring.
  lpUserData | The user data supplied to register-callback function.
  lpUser | The properties of the user.
  lpTextMessage | The text message being sent.

Definition at line 348 of file TeamTalkSrv.h.

## ◆ ChannelCreatedCallback

typedef void ChannelCreatedCallback(IN TTSInstance *lpTTSInstance, IN VOID *lpUserData, IN const Channel *lpChannel, IN const User *lpUser)

Callback when a new channel has been created.

This callback occurs in the context of TT_DoMakeChannel() or TT_DoJoinChannel().

Register using TTS_RegisterChannelCreatedCallback().

Parameters

  lpTTSInstance | The server instance where the event is occurring.
  lpUserData | The user data supplied to register-callback function.
  lpChannel | The channel which has been created.
  lpUser | The user who created the channel. This can be 0.

Definition at line 363 of file TeamTalkSrv.h.

## ◆ ChannelUpdatedCallback

typedef void ChannelUpdatedCallback(IN TTSInstance *lpTTSInstance, IN VOID *lpUserData, IN const Channel *lpChannel, IN const User *lpUser)

Callback when a channel has been updated.

This callback occurs in the context of TT_DoUpdateChannel().

Register using TTS_RegisterChannelUpdatedCallback().

Parameters

  lpTTSInstance | The server instance where the event is occurring.
  lpUserData | The user data supplied to register-callback function.
  lpChannel | The new properties of the channel.
  lpUser | The user who initiated the update. This can be 0.

Definition at line 377 of file TeamTalkSrv.h.

## ◆ ChannelRemovedCallback

typedef void ChannelRemovedCallback(IN TTSInstance *lpTTSInstance, IN VOID *lpUserData, IN const Channel *lpChannel, IN const User *lpUser)

Callback when channel has been removed.

Register using TTS_RegisterChannelRemovedCallback().

Parameters

  lpTTSInstance | The server instance where the event is occurring.
  lpUserData | The user data supplied to register-callback function.
  lpChannel | The properties of the channel which has been removed.
  lpUser | The properties of the who initiated the removal. This can be 0.

Definition at line 390 of file TeamTalkSrv.h.

## ◆ FileUploadedCallback

typedef void FileUploadedCallback(IN TTSInstance *lpTTSInstance, IN VOID *lpUserData, IN const RemoteFile *lpRemoteFile, IN const User *lpUser)

Callback when a new file has been uploaded to a channel.

Register using TTS_RegisterFileUploadedCallback().

Parameters

  lpTTSInstance | The server instance where the event is occurring.
  lpUserData | The user data supplied to register-callback function.
  lpRemoteFile | The properties of the file.
  lpUser | The properties of the user who uploaded the file.

Definition at line 402 of file TeamTalkSrv.h.

## ◆ FileDownloadedCallback

typedef void FileDownloadedCallback(IN TTSInstance *lpTTSInstance, IN VOID *lpUserData, IN const RemoteFile *lpRemoteFile, IN const User *lpUser)

Callback when a user has downloaded a file.

Register using TTS_RegisterFileDownloadedCallback().

Parameters

  lpTTSInstance | The server instance where the event is occurring.
  lpUserData | The user data supplied to register-callback function.
  lpRemoteFile | The properties of the file.
  lpUser | The properties of the user who downloaded the file.

Definition at line 415 of file TeamTalkSrv.h.

## ◆ FileDeletedCallback

typedef void FileDeletedCallback(IN TTSInstance *lpTTSInstance, IN VOID *lpUserData, IN const RemoteFile *lpRemoteFile, IN const User *lpUser)

Callback when a user has deleted a file.

Register using TTS_RegisterFileDeletedCallback().

Parameters

  lpTTSInstance | The server instance where the event is occurring.
  lpUserData | The user data supplied to register-callback function.
  lpRemoteFile | The properties of the file.
  lpUser | The properties of the user who deleted the file.

Definition at line 428 of file TeamTalkSrv.h.

## ◆ ServerUpdatedCallback

typedef void ServerUpdatedCallback(IN TTSInstance *lpTTSInstance, IN VOID *lpUserData, IN const ServerProperties *lpServerProperties, IN const User *lpUser)

Callback when a user has updated the server properties.

This callback occurs in the context of TT_DoUpdateServer().

Register using TTS_RegisterServerUpdatedCallback().

Parameters

  lpTTSInstance | The server instance where the event is occurring.
  lpUserData | The user data supplied to register-callback function.
  lpServerProperties | The properties of the server.
  lpUser | The user who initiated the server update.

Definition at line 443 of file TeamTalkSrv.h.

## ◆ SaveServerConfigCallback

typedef void SaveServerConfigCallback(IN TTSInstance *lpTTSInstance, IN VOID *lpUserData, IN const User *lpUser)

Callback when a user has reguested to save the server configuration.

Register using TTS_RegisterSaveServerConfigCallback().

Parameters

  lpTTSInstance | The server instance where the event is occurring.
  lpUserData | The user data supplied to register-callback function.
  lpUser | The properties of the user who requested to save the server configuration. This can be 0.

Definition at line 457 of file TeamTalkSrv.h.

## Function Documentation

## ◆ TTS_RegisterUserConnectedCallback()

TEAMTALKDLL_API TTBOOL TTS_RegisterUserConnectedCallback | ( | IN TTSInstance * | lpTTSInstance,
|  | IN UserConnectedCallback * | lpCallback,
|  | IN VOID * | lpUserData,
|  | IN TTBOOL | bEnable )

Register a callback when a user connects to the server.

Parameters

  lpTTSInstance | Pointer to the server instance created by TTS_InitTeamTalk().
  lpCallback | Pointer to a function which will handle the callback.
  lpUserData | A pointer which will be passed to the callback function.
  bEnable | Whether to register or unregister the callback.

Returns
  Returns TRUE if the call was successful.

## ◆ TTS_RegisterUserLoggedInCallback()

TEAMTALKDLL_API TTBOOL TTS_RegisterUserLoggedInCallback | ( | IN TTSInstance * | lpTTSInstance,
|  | IN UserLoggedInCallback * | lpCallback,
|  | IN VOID * | lpUserData,
|  | IN TTBOOL | bEnable )

Register a callback when a user logs on to the server.

Parameters

  lpTTSInstance | Pointer to the server instance created by TTS_InitTeamTalk().
  lpCallback | Pointer to a function which will handle the callback.
  lpUserData | A pointer which will be passed to the callback function.
  bEnable | Whether to register or unregister the callback.

Returns
  Returns TRUE if the call was successful.

## ◆ TTS_RegisterUserLoggedOutCallback()

TEAMTALKDLL_API TTBOOL TTS_RegisterUserLoggedOutCallback | ( | IN TTSInstance * | lpTTSInstance,
|  | IN UserLoggedOutCallback * | lpCallback,
|  | IN VOID * | lpUserData,
|  | IN TTBOOL | bEnable )

Register a callback when a user logs out of the server.

Parameters

  lpTTSInstance | Pointer to the server instance created by TTS_InitTeamTalk().
  lpCallback | Pointer to a function which will handle the callback.
  lpUserData | A pointer which will be passed to the callback function.
  bEnable | Whether to register or unregister the callback.

Returns
  Returns TRUE if the call was successful.

## ◆ TTS_RegisterUserDisconnectedCallback()

TEAMTALKDLL_API TTBOOL TTS_RegisterUserDisconnectedCallback | ( | IN TTSInstance * | lpTTSInstance,
|  | IN UserDisconnectedCallback * | lpCallback,
|  | IN VOID * | lpUserData,
|  | IN TTBOOL | bEnable )

Register a callback when a user disconnects from the server.

Parameters

  lpTTSInstance | Pointer to the server instance created by TTS_InitTeamTalk().
  lpCallback | Pointer to a function which will handle the callback.
  lpUserData | A pointer which will be passed to the callback function.
  bEnable | Whether to register or unregister the callback.

Returns
  Returns TRUE if the call was successful.

## ◆ TTS_RegisterUserTimedoutCallback()

TEAMTALKDLL_API TTBOOL TTS_RegisterUserTimedoutCallback | ( | IN TTSInstance * | lpTTSInstance,
|  | IN UserTimedoutCallback * | lpCallback,
|  | IN VOID * | lpUserData,
|  | IN TTBOOL | bEnable )

Register a callback when a user is dropped because of inactivity.

See `nUserTimeout` in ServerProperties.

Parameters

  lpTTSInstance | Pointer to the server instance created by TTS_InitTeamTalk().
  lpCallback | Pointer to a function which will handle the callback.
  lpUserData | A pointer which will be passed to the callback function.
  bEnable | Whether to register or unregister the callback.

Returns
  Returns TRUE if the call was successful.

## ◆ TTS_RegisterUserKickedCallback()

TEAMTALKDLL_API TTBOOL TTS_RegisterUserKickedCallback | ( | IN TTSInstance * | lpTTSInstance,
|  | IN UserKickedCallback * | lpCallback,
|  | IN VOID * | lpUserData,
|  | IN TTBOOL | bEnable )

Register a callback when a user is kicked from the server.

Parameters

  lpTTSInstance | Pointer to the server instance created by TTS_InitTeamTalk().
  lpCallback | Pointer to a function which will handle the callback.
  lpUserData | A pointer which will be passed to the callback function.
  bEnable | Whether to register or unregister the callback.

Returns
  Returns TRUE if the call was successful.

## ◆ TTS_RegisterUserBannedCallback()

TEAMTALKDLL_API TTBOOL TTS_RegisterUserBannedCallback | ( | IN TTSInstance * | lpTTSInstance,
|  | IN UserBannedCallback * | lpCallback,
|  | IN VOID * | lpUserData,
|  | IN TTBOOL | bEnable )

Register a callback when a user is banned from the server.

Parameters

  lpTTSInstance | Pointer to the server instance created by TTS_InitTeamTalk().
  lpCallback | Pointer to a function which will handle the callback.
  lpUserData | A pointer which will be passed to the callback function.
  bEnable | Whether to register or unregister the callback.

Returns
  Returns TRUE if the call was successful.

## ◆ TTS_RegisterUserUnbannedCallback()

TEAMTALKDLL_API TTBOOL TTS_RegisterUserUnbannedCallback | ( | IN TTSInstance * | lpTTSInstance,
|  | IN UserUnbannedCallback * | lpCallback,
|  | IN VOID * | lpUserData,
|  | IN TTBOOL | bEnable )

Register a callback when an IP-address is unbanned from the server.

Parameters

  lpTTSInstance | Pointer to the server instance created by TTS_InitTeamTalk().
  lpCallback | Pointer to a function which will handle the callback.
  lpUserData | A pointer which will be passed to the callback function.
  bEnable | Whether to register or unregister the callback.

Returns
  Returns TRUE if the call was successful.

## ◆ TTS_RegisterUserUpdatedCallback()

TEAMTALKDLL_API TTBOOL TTS_RegisterUserUpdatedCallback | ( | IN TTSInstance * | lpTTSInstance,
|  | IN UserUpdatedCallback * | lpCallback,
|  | IN VOID * | lpUserData,
|  | IN TTBOOL | bEnable )

Register a callback when an user's properties are updated.

Parameters

  lpTTSInstance | Pointer to the server instance created by TTS_InitTeamTalk().
  lpCallback | Pointer to a function which will handle the callback.
  lpUserData | A pointer which will be passed to the callback function.
  bEnable | Whether to register or unregister the callback.

Returns
  Returns TRUE if the call was successful.

## ◆ TTS_RegisterUserJoinedChannelCallback()

TEAMTALKDLL_API TTBOOL TTS_RegisterUserJoinedChannelCallback | ( | IN TTSInstance * | lpTTSInstance,
|  | IN UserJoinedChannelCallback * | lpCallback,
|  | IN VOID * | lpUserData,
|  | IN TTBOOL | bEnable )

Register a callback when an user joins a channel.

Parameters

  lpTTSInstance | Pointer to the server instance created by TTS_InitTeamTalk().
  lpCallback | Pointer to a function which will handle the callback.
  lpUserData | A pointer which will be passed to the callback function.
  bEnable | Whether to register or unregister the callback.

Returns
  Returns TRUE if the call was successful.

## ◆ TTS_RegisterUserLeftChannelCallback()

TEAMTALKDLL_API TTBOOL TTS_RegisterUserLeftChannelCallback | ( | IN TTSInstance * | lpTTSInstance,
|  | IN UserLeftChannelCallback * | lpCallback,
|  | IN VOID * | lpUserData,
|  | IN TTBOOL | bEnable )

Register a callback when an user leaves a channel.

Parameters

  lpTTSInstance | Pointer to the server instance created by TTS_InitTeamTalk().
  lpCallback | Pointer to a function which will handle the callback.
  lpUserData | A pointer which will be passed to the callback function.
  bEnable | Whether to register or unregister the callback.

Returns
  Returns TRUE if the call was successful.

## ◆ TTS_RegisterUserMovedCallback()

TEAMTALKDLL_API TTBOOL TTS_RegisterUserMovedCallback | ( | IN TTSInstance * | lpTTSInstance,
|  | IN UserMovedCallback * | lpCallback,
|  | IN VOID * | lpUserData,
|  | IN TTBOOL | bEnable )

Register a callback when a user is moved.

Parameters

  lpTTSInstance | Pointer to the server instance created by TTS_InitTeamTalk().
  lpCallback | Pointer to a function which will handle the callback.
  lpUserData | A pointer which will be passed to the callback function.
  bEnable | Whether to register or unregister the callback.

Returns
  Returns TRUE if the call was successful.

## ◆ TTS_RegisterUserTextMessageCallback()

TEAMTALKDLL_API TTBOOL TTS_RegisterUserTextMessageCallback | ( | IN TTSInstance * | lpTTSInstance,
|  | IN UserTextMessageCallback * | lpCallback,
|  | IN VOID * | lpUserData,
|  | IN TTBOOL | bEnable )

Register a callback when a user send a text message.

Parameters

  lpTTSInstance | Pointer to the server instance created by TTS_InitTeamTalk().
  lpCallback | Pointer to a function which will handle the callback.
  lpUserData | A pointer which will be passed to the callback function.
  bEnable | Whether to register or unregister the callback.

Returns
  Returns TRUE if the call was successful.

## ◆ TTS_RegisterChannelCreatedCallback()

TEAMTALKDLL_API TTBOOL TTS_RegisterChannelCreatedCallback | ( | IN TTSInstance * | lpTTSInstance,
|  | IN ChannelCreatedCallback * | lpCallback,
|  | IN VOID * | lpUserData,
|  | IN TTBOOL | bEnable )

Register a callback when a channel is created.

Parameters

  lpTTSInstance | Pointer to the server instance created by TTS_InitTeamTalk().
  lpCallback | Pointer to a function which will handle the callback.
  lpUserData | A pointer which will be passed to the callback function.
  bEnable | Whether to register or unregister the callback.

Returns
  Returns TRUE if the call was successful.

## ◆ TTS_RegisterChannelUpdatedCallback()

TEAMTALKDLL_API TTBOOL TTS_RegisterChannelUpdatedCallback | ( | IN TTSInstance * | lpTTSInstance,
|  | IN ChannelUpdatedCallback * | lpCallback,
|  | IN VOID * | lpUserData,
|  | IN TTBOOL | bEnable )

Register a callback when a channel is updated.

Parameters

  lpTTSInstance | Pointer to the server instance created by TTS_InitTeamTalk().
  lpCallback | Pointer to a function which will handle the callback.
  lpUserData | A pointer which will be passed to the callback function.
  bEnable | Whether to register or unregister the callback.

Returns
  Returns TRUE if the call was successful.

## ◆ TTS_RegisterChannelRemovedCallback()

TEAMTALKDLL_API TTBOOL TTS_RegisterChannelRemovedCallback | ( | IN TTSInstance * | lpTTSInstance,
|  | IN ChannelRemovedCallback * | lpCallback,
|  | IN VOID * | lpUserData,
|  | IN TTBOOL | bEnable )

Register a callback when a channel is removed.

Parameters

  lpTTSInstance | Pointer to the server instance created by TTS_InitTeamTalk().
  lpCallback | Pointer to a function which will handle the callback.
  lpUserData | A pointer which will be passed to the callback function.
  bEnable | Whether to register or unregister the callback.

Returns
  Returns TRUE if the call was successful.

## ◆ TTS_RegisterFileUploadedCallback()

TEAMTALKDLL_API TTBOOL TTS_RegisterFileUploadedCallback | ( | IN TTSInstance * | lpTTSInstance,
|  | IN FileUploadedCallback * | lpCallback,
|  | IN VOID * | lpUserData,
|  | IN TTBOOL | bEnable )

Register a callback when a file is uploaded.

Parameters

  lpTTSInstance | Pointer to the server instance created by TTS_InitTeamTalk().
  lpCallback | Pointer to a function which will handle the callback.
  lpUserData | A pointer which will be passed to the callback function.
  bEnable | Whether to register or unregister the callback.

Returns
  Returns TRUE if the call was successful.

## ◆ TTS_RegisterFileDownloadedCallback()

TEAMTALKDLL_API TTBOOL TTS_RegisterFileDownloadedCallback | ( | IN TTSInstance * | lpTTSInstance,
|  | IN FileDownloadedCallback * | lpCallback,
|  | IN VOID * | lpUserData,
|  | IN TTBOOL | bEnable )

Register a callback when a file is downloaded.

Parameters

  lpTTSInstance | Pointer to the server instance created by TTS_InitTeamTalk().
  lpCallback | Pointer to a function which will handle the callback.
  lpUserData | A pointer which will be passed to the callback function.
  bEnable | Whether to register or unregister the callback.

Returns
  Returns TRUE if the call was successful.

## ◆ TTS_RegisterFileDeletedCallback()

TEAMTALKDLL_API TTBOOL TTS_RegisterFileDeletedCallback | ( | IN TTSInstance * | lpTTSInstance,
|  | IN FileDeletedCallback * | lpCallback,
|  | IN VOID * | lpUserData,
|  | IN TTBOOL | bEnable )

Register a callback when a file is deleted.

Parameters

  lpTTSInstance | Pointer to the server instance created by TTS_InitTeamTalk().
  lpCallback | Pointer to a function which will handle the callback.
  lpUserData | A pointer which will be passed to the callback function.
  bEnable | Whether to register or unregister the callback.

Returns
  Returns TRUE if the call was successful.

## ◆ TTS_RegisterServerUpdatedCallback()

TEAMTALKDLL_API TTBOOL TTS_RegisterServerUpdatedCallback | ( | IN TTSInstance * | lpTTSInstance,
|  | IN ServerUpdatedCallback * | lpCallback,
|  | IN VOID * | lpUserData,
|  | IN TTBOOL | bEnable )

Register a callback when a server's properties has been updated.

Parameters

  lpTTSInstance | Pointer to the server instance created by TTS_InitTeamTalk().
  lpCallback | Pointer to a function which will handle the callback.
  lpUserData | A pointer which will be passed to the callback function.
  bEnable | Whether to register or unregister the callback.

Returns
  Returns TRUE if the call was successful.

## ◆ TTS_RegisterSaveServerConfigCallback()

TEAMTALKDLL_API TTBOOL TTS_RegisterSaveServerConfigCallback | ( | IN TTSInstance * | lpTTSInstance,
|  | IN SaveServerConfigCallback * | lpCallback,
|  | IN VOID * | lpUserData,
|  | IN TTBOOL | bEnable )

Register a callback when a user requests the server to save its configuration.

Parameters

  lpTTSInstance | Pointer to the server instance created by TTS_InitTeamTalk().
  lpCallback | Pointer to a function which will handle the callback.
  lpUserData | A pointer which will be passed to the callback function.
  bEnable | Whether to register or unregister the callback.

Returns
  Returns TRUE if the call was successful.