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

Public Attributes
string	szUsername
	The account's username.

string	szPassword
	The account's password.

UserType	uUserType
	A bitmask of the type of user based on BearWare.UserType.

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

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

string	szNote
	Additional notes about this user.

string	szInitChannel
	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.

int[]	autoOperatorChannels
	Channels where this user will automatically become channel operator when joining. The channels must be of type BearWare.ChannelType.CHANNEL_PERMANENT.

int	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.

string	szLastModified
	Timestamp of last modification of user account. 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: TeamTalkBase.DoListUserAccounts; TeamTalkBase.DoNewUserAccount; TeamTalkBase.DoDeleteUserAccount

Definition at line 2126 of file TeamTalk.cs.

Member Data Documentation

◆ szUsername

string BearWare.UserAccount.szUsername

The account's username.

Definition at line 2130 of file TeamTalk.cs.

◆ szPassword

string BearWare.UserAccount.szPassword

The account's password.

Definition at line 2133 of file TeamTalk.cs.

◆ uUserType

UserType BearWare.UserAccount.uUserType

A bitmask of the type of user based on BearWare.UserType.

Definition at line 2135 of file TeamTalk.cs.

◆ uUserRights

UserRight BearWare.UserAccount.uUserRights

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

Definition at line 2139 of file TeamTalk.cs.

◆ nUserData

int BearWare.UserAccount.nUserData

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

Definition at line 2143 of file TeamTalk.cs.

◆ szNote

string BearWare.UserAccount.szNote

Additional notes about this user.

Definition at line 2146 of file TeamTalk.cs.

◆ szInitChannel

string BearWare.UserAccount.szInitChannel

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: TeamTalkBase.DoJoinChannel()

Definition at line 2152 of file TeamTalk.cs.

◆ autoOperatorChannels

int [] BearWare.UserAccount.autoOperatorChannels

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

See also: TeamTalkBase.DoChannelOp()

Definition at line 2157 of file TeamTalk.cs.

◆ nAudioCodecBpsLimit

int BearWare.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 2161 of file TeamTalk.cs.

◆ abusePrevent

AbusePrevention BearWare.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 2166 of file TeamTalk.cs.

◆ szLastModified

string BearWare.UserAccount.szLastModified

Timestamp of last modification of user account. Date/time is converted local time.

Definition at line 2170 of file TeamTalk.cs.

Public Attributes