TeamTalk 5 C-API DLL: UserAccount Struct Reference

TeamTalk 5 C-API DLL Version 5.18A

Loading...
Searching...
No Matches
Public Attributes | List of all members
UserAccount Struct Reference
Server Administration

A struct containing the properties of a user account. More...

`#include <TeamTalk.h>`

## Public Attributes

TTCHAR | szUsername [TT_STRLEN]
| The account's username.
TTCHAR | szPassword [TT_STRLEN]
| The account's password.
UserTypes | uUserType
| A bitmask of the type of user based on UserType.
UserRights | uUserRights
| A bitmask based on UserRight which specifies the rights the user have who logs onto the server. A user of type USERTYPE_ADMIN by default has all rights.
INT32 | nUserData
| A user data field which can be used for additional information. The nUserData field of the User struct will contain this value when a user who logs in with this account.
TTCHAR | szNote [TT_STRLEN]
| Additional notes about this user.
TTCHAR | szInitChannel [TT_STRLEN]
| User should (manually) join this channel after login. If an initial channel is specified in the user's account then no password is required for the user to join the channel.
INT32 | autoOperatorChannels [TT_CHANNELS_OPERATOR_MAX]
| Channels where this user will automatically become channel operator when joining. The channels must be of type CHANNEL_PERMANENT.
INT32 | nAudioCodecBpsLimit
| Bandwidth restriction for audio codecs created by this user. This value will hold the highest bitrate which is allowed for audio codecs. 0 = no limit.
AbusePrevention | abusePrevent
| Properties which can be set to prevent abuse of a server, e.g. limit number of commands issued.
TTCHAR | szLastModified [TT_STRLEN]
| Timestamp of last modification of user account. Read-only property. Date/time is converted local time.
TTCHAR | szLastLoginTime [TT_STRLEN]
| Timestamp of user account's last successful login. Read-only property. Date/time is converted local time.

## Detailed Description

A struct containing the properties of a user account.

A registered user is one that has a user account on the server.

See also
  TT_DoListUserAccounts
  TT_DoNewUserAccount
  TT_DoDeleteUserAccount

Definition at line 2012 of file TeamTalk.h.

## Member Data Documentation

## ◆ szUsername

TTCHAR UserAccount::szUsername[TT_STRLEN]

The account's username.

Definition at line 2015 of file TeamTalk.h.

## ◆ szPassword

TTCHAR UserAccount::szPassword[TT_STRLEN]

The account's password.

Definition at line 2017 of file TeamTalk.h.

## ◆ uUserType

UserTypes UserAccount::uUserType

A bitmask of the type of user based on UserType.

Definition at line 2019 of file TeamTalk.h.

## ◆ uUserRights

UserRights UserAccount::uUserRights

A bitmask based on UserRight which specifies the rights the user have who logs onto the server. A user of type USERTYPE_ADMIN by default has all rights.

Definition at line 2023 of file TeamTalk.h.

## ◆ nUserData

INT32 UserAccount::nUserData

A user data field which can be used for additional information. The nUserData field of the User struct will contain this value when a user who logs in with this account.

Definition at line 2027 of file TeamTalk.h.

## ◆ szNote

TTCHAR UserAccount::szNote[TT_STRLEN]

Additional notes about this user.

Definition at line 2029 of file TeamTalk.h.

## ◆ szInitChannel

TTCHAR UserAccount::szInitChannel[TT_STRLEN]

User should (manually) join this channel after login. If an initial channel is specified in the user's account then no password is required for the user to join the channel.

See also
  TT_DoJoinChannel()

Definition at line 2034 of file TeamTalk.h.

## ◆ autoOperatorChannels

INT32 UserAccount::autoOperatorChannels[TT_CHANNELS_OPERATOR_MAX]

Channels where this user will automatically become channel operator when joining. The channels must be of type CHANNEL_PERMANENT.

See also
  TT_DoChannelOp()

Definition at line 2038 of file TeamTalk.h.

## ◆ nAudioCodecBpsLimit

INT32 UserAccount::nAudioCodecBpsLimit

Bandwidth restriction for audio codecs created by this user. This value will hold the highest bitrate which is allowed for audio codecs. 0 = no limit.

See also
  AudioCodec

Definition at line 2042 of file TeamTalk.h.

## ◆ abusePrevent

AbusePrevention UserAccount::abusePrevent

Properties which can be set to prevent abuse of a server, e.g. limit number of commands issued.

Requires TeamTalk version 5.2.3.4896.

Definition at line 2047 of file TeamTalk.h.

## ◆ szLastModified

TTCHAR UserAccount::szLastModified[TT_STRLEN]

Timestamp of last modification of user account. Read-only property. Date/time is converted local time.

Definition at line 2050 of file TeamTalk.h.

## ◆ szLastLoginTime

TTCHAR UserAccount::szLastLoginTime[TT_STRLEN]

Timestamp of user account's last successful login. Read-only property. Date/time is converted local time.

Definition at line 2053 of file TeamTalk.h.