TeamTalk 5 Java DLL: Server Request Callbacks

TeamTalk 5 Java DLL Version 5.18A

Loading...
Searching...
No Matches
Functions | Events
Server Request Callbacks

Handle user requests to the server. More...

## Functions

delegate void | BearWare.TeamTalk5Srv.UserLogin (ref ClientErrorMsg lpClientErrorMsg, ref User lpUser, ref UserAccount lpUserAccount)
| Callback when a user is requesting to log on to the server.
delegate void | BearWare.TeamTalk5Srv.UserChangeNickname (ref ClientErrorMsg lpClientErrorMsg, ref User lpUser, string szNewNickname)
| Callback when a user is requesting to change nickname.
delegate void | BearWare.TeamTalk5Srv.UserChangeStatus (ref ClientErrorMsg lpClientErrorMsg, ref User lpUser, ref int nNewStatusMode, string szNewStatusMsg)
| Callback when a user is requesting to change status.
delegate void | BearWare.TeamTalk5Srv.UserCreateUserAccount (ref ClientErrorMsg lpClientErrorMsg, ref User lpUser, ref UserAccount lpUserAccount)
| Callback when a user is requesting to create a new user account.
delegate void | BearWare.TeamTalk5Srv.UserDeleteUserAccount (ref ClientErrorMsg lpClientErrorMsg, ref User lpUser, string szUsername)
| Callback when a user is requesting to delete a user account.
delegate void | BearWare.TeamTalk5Srv.UserAddServerBan (ref ClientErrorMsg lpClientErrorMsg, ref User lpBanner, ref User lpBanee)
| Callback when a user is requesting to ban a user.
delegate void | BearWare.TeamTalk5Srv.UserAddServerBanIPAddress (ref ClientErrorMsg lpClientErrorMsg, ref User lpBanner, string szIPAddress)
| Callback when a user is requesting to ban an IP-address.
delegate void | BearWare.TeamTalk5Srv.UserDeleteServerBan (ref ClientErrorMsg lpClientErrorMsg, ref User lpUser, string szIPAddress)
| Callback when a user is requesting to remove a ban.

## Events

UserLogin | BearWare.TeamTalk5Srv.OnUserLogin
| Register using #UserLogin delegate.
UserChangeNickname | BearWare.TeamTalk5Srv.OnUserChangeNickname
| Register using #UserChangeNickname delegate.
UserChangeStatus | BearWare.TeamTalk5Srv.OnUserChangeStatus
| Register using #UserChangeStatus delegate.
UserCreateUserAccount | BearWare.TeamTalk5Srv.OnUserCreateUserAccount
| Register using #UserCreateUserAccount delegate.
UserDeleteUserAccount | BearWare.TeamTalk5Srv.OnUserDeleteUserAccount
| Register using #UserCreateUserAccount delegate.
UserAddServerBan | BearWare.TeamTalk5Srv.OnUserAddServerBan
| Register using #UserAddServerBan delegate.
UserAddServerBanIPAddress | BearWare.TeamTalk5Srv.OnUserAddServerBanIPAddress
| Register using #UserAddServerBan delegate.
UserDeleteServerBan | BearWare.TeamTalk5Srv.OnUserDeleteServerBan
| Register using #UserAddServerBanIPAddress delegate.

## Detailed Description

Handle user requests to the server.

Callbacks of this type are invoked when a client application has issued a command to the server, basically called a `TeamTalkBase.Do*` method (one example could be TeamTalkBase.DoLogin()).

To get a callback when a user wants to log in listen for event TeamTalk5Srv.OnUserLogin(). If the user should be allowed to log on pass ClientError.CMDERR_SUCCESS to the BearWare.ClientErrorMsg provided by the TeamTalk server API. If not pass any another value which will then be returned to the client application.

## Function Documentation

## ◆ UserLogin()

delegate void BearWare.TeamTalk5Srv.UserLogin | ( | ref ClientErrorMsg | lpClientErrorMsg,
|  | ref User | lpUser,
|  | ref UserAccount | lpUserAccount )

Callback when a user is requesting to log on to the server.

This callback occurs in the context of TeamTalkBase.DoLogin().

Parameters

  lpClientErrorMsg | Error message which should be sent back to user. Set `nErrorNo` to BearWare.ClientError.CMDERR_SUCCESS if user is authorized.
  lpUser | The user properties gathered so far.
  lpUserAccount | The user account information which should be set for this user.

## ◆ UserChangeNickname()

delegate void BearWare.TeamTalk5Srv.UserChangeNickname | ( | ref ClientErrorMsg | lpClientErrorMsg,
|  | ref User | lpUser,
|  | string | szNewNickname )

Callback when a user is requesting to change nickname.

This callback occurs in the context of TeamTalkBase.DoChangeNickname()

Parameters

  lpClientErrorMsg | Error message which should be sent back to user. Set `nErrorNo` to BearWare.ClientError.CMDERR_SUCCESS if user is authorized.
  lpUser | The user's properties.
  szNewNickname | The new nickname requested by the user.

## ◆ UserChangeStatus()

delegate void BearWare.TeamTalk5Srv.UserChangeStatus | ( | ref ClientErrorMsg | lpClientErrorMsg,
|  | ref User | lpUser,
|  | ref int | nNewStatusMode,
|  | string | szNewStatusMsg )

Callback when a user is requesting to change status.

This callback occurs in the context of TeamTalkBase.DoChangeStatus()

Parameters

  lpClientErrorMsg | Error message which should be sent back to user. Set `nErrorNo` to BearWare.ClientError.CMDERR_SUCCESS if user is authorized.
  lpUser | The user's properties.
  nNewStatusMode | The new status mode requested by the user.
  szNewStatusMsg | The new status message requested by the user.

## ◆ UserCreateUserAccount()

delegate void BearWare.TeamTalk5Srv.UserCreateUserAccount | ( | ref ClientErrorMsg | lpClientErrorMsg,
|  | ref User | lpUser,
|  | ref UserAccount | lpUserAccount )

Callback when a user is requesting to create a new user account.

This callback occurs in the context of TeamTalkBase.DoNewUserAccount().

Parameters

  lpClientErrorMsg | Error message which should be sent back to user. Set `nErrorNo` to BearWare.ClientError.CMDERR_SUCCESS if user is authorized.
  lpUser | The user's properties.
  lpUserAccount | The properties of the user account to be created.

## ◆ UserDeleteUserAccount()

delegate void BearWare.TeamTalk5Srv.UserDeleteUserAccount | ( | ref ClientErrorMsg | lpClientErrorMsg,
|  | ref User | lpUser,
|  | string | szUsername )

Callback when a user is requesting to delete a user account.

This callback occurs in the context of TeamTalkBase.DoDeleteUserAccount().

Parameters

  lpClientErrorMsg | Error message which should be sent back to user. Set `nErrorNo` to BearWare.ClientError.CMDERR_SUCCESS if user is authorized.
  lpUser | The properties of the user requesting.
  szUsername | The username of the account to delete.

## ◆ UserAddServerBan()

delegate void BearWare.TeamTalk5Srv.UserAddServerBan | ( | ref ClientErrorMsg | lpClientErrorMsg,
|  | ref User | lpBanner,
|  | ref User | lpBanee )

Callback when a user is requesting to ban a user.

This callback occurs in the context of TeamTalkBase.DoBanUser().

Parameters

  lpClientErrorMsg | Error message which should be sent back to user. Set `nErrorNo` to BearWare.ClientError.CMDERR_SUCCESS if user is authorized.
  lpBanner | The properties of the user requesting the ban.
  lpBanee | The properties of the user who should be banned.

## ◆ UserAddServerBanIPAddress()

delegate void BearWare.TeamTalk5Srv.UserAddServerBanIPAddress | ( | ref ClientErrorMsg | lpClientErrorMsg,
|  | ref User | lpBanner,
|  | string | szIPAddress )

Callback when a user is requesting to ban an IP-address.

This callback occurs in the context of TeamTalkBase.DoBanIPAddress().

Parameters

  lpClientErrorMsg | Error message which should be sent back to user. Set `nErrorNo` to BearWare.ClientError.CMDERR_SUCCESS if user is authorized.
  lpBanner | The properties of the user requesting the ban. This value can be NULL if BearWare.ServerProperties `nMaxLoginAttempts` is enabled.
  szIPAddress | The IP-address to be banned.

## ◆ UserDeleteServerBan()

delegate void BearWare.TeamTalk5Srv.UserDeleteServerBan | ( | ref ClientErrorMsg | lpClientErrorMsg,
|  | ref User | lpUser,
|  | string | szIPAddress )

Callback when a user is requesting to remove a ban.

This callback occurs in the context of TeamTalkBase.DoUnBanUser().

Parameters

  lpClientErrorMsg | Error message which should be sent back to user. Set `nErrorNo` to BearWare.ClientError.CMDERR_SUCCESS if user is authorized.
  lpUser | The properties of the user doing the request.
  szIPAddress | The IP-address to be unbanned.

## Events

## ◆ OnUserLogin

UserLogin BearWare.TeamTalk5Srv.OnUserLogin

Register using #UserLogin delegate.

Definition at line 64 of file TeamTalkSrv.cs.

## ◆ OnUserChangeNickname

UserChangeNickname BearWare.TeamTalk5Srv.OnUserChangeNickname

Register using #UserChangeNickname delegate.

Definition at line 79 of file TeamTalkSrv.cs.

## ◆ OnUserChangeStatus

UserChangeStatus BearWare.TeamTalk5Srv.OnUserChangeStatus

Register using #UserChangeStatus delegate.

Definition at line 94 of file TeamTalkSrv.cs.

## ◆ OnUserCreateUserAccount

UserCreateUserAccount BearWare.TeamTalk5Srv.OnUserCreateUserAccount

Register using #UserCreateUserAccount delegate.

Definition at line 110 of file TeamTalkSrv.cs.

## ◆ OnUserDeleteUserAccount

UserDeleteUserAccount BearWare.TeamTalk5Srv.OnUserDeleteUserAccount

Register using #UserCreateUserAccount delegate.

Definition at line 126 of file TeamTalkSrv.cs.

## ◆ OnUserAddServerBan

UserAddServerBan BearWare.TeamTalk5Srv.OnUserAddServerBan

Register using #UserAddServerBan delegate.

Definition at line 141 of file TeamTalkSrv.cs.

## ◆ OnUserAddServerBanIPAddress

UserAddServerBanIPAddress BearWare.TeamTalk5Srv.OnUserAddServerBanIPAddress

Register using #UserAddServerBan delegate.

Definition at line 157 of file TeamTalkSrv.cs.

## ◆ OnUserDeleteServerBan

UserDeleteServerBan BearWare.TeamTalk5Srv.OnUserDeleteServerBan

Register using #UserAddServerBanIPAddress delegate.

Definition at line 172 of file TeamTalkSrv.cs.