Instance Methods
Connection and disconnection events

(void)	- serverModel:joinedServerAsUser:

(void)	- serverModel:joinedServerAsUser:withWelcomeMessage:

(void)	- serverModelDisconnected:

User changes

(void)	- serverModel:userJoined:

(void)	- serverModel:userTalkStateChanged:

(void)	- serverModel:userRenamed:

(void)	- serverModel:userMoved:toChannel:byUser:

(void)	- serverModel:userMoved:toChannel:fromChannel:byUser:

(void)	- serverModel:userCommentChanged:

(void)	- serverModel:userTextureChanged:

Text messages

(void)	- serverModel:textMessageReceived:fromUser:

Self-mute and self-deafen

(void)	- serverModel:userSelfMuted:

(void)	- serverModel:userRemovedSelfMute:

(void)	- serverModel:userSelfMutedAndDeafened:

(void)	- serverModel:userRemovedSelfMuteAndDeafen:

(void)	- serverModel:userSelfMuteDeafenStateChanged:

Muting, deafening and suppressing

(void)	- serverModel:userMutedAndDeafened:byUser:

(void)	- serverModel:userUnmutedAndUndeafened:byUser:

(void)	- serverModel:userMuted:byUser:

(void)	- serverModel:userUnmuted:byUser:

(void)	- serverModel:userDeafened:byUser:

(void)	- serverModel:userUndeafened:byUser:

(void)	- serverModel:userSuppressed:byUser:

(void)	- serverModel:userUnsuppressed:byUser:

(void)	- serverModel:userMuteStateChanged:

Other user flag changes

(void)	- serverModel:userAuthenticatedStateChanged:

(void)	- serverModel:userPrioritySpeakerChanged:

(void)	- serverModel:userRecordingStateChanged:

Leaving users

(void)	- serverModel:userBanned:byUser:forReason:

(void)	- serverModel:userKicked:byUser:forReason:

(void)	- serverModel:userDisconnected:

(void)	- serverModel:userLeft:

Channel-related events

(void)	- serverModel:channelAdded:

(void)	- serverModel:channelRemoved:

(void)	- serverModel:channelRenamed:

(void)	- serverModel:channelPositionChanged:

(void)	- serverModel:channelMoved:

(void)	- serverModel:channelDescriptionChanged:

(void)	- serverModel:linksSet:forChannel:

(void)	- serverModel:linksAdded:toChannel:

(void)	- serverModel:linksRemoved:fromChannel:

(void)	- serverModel:linksChangedForChannel:

Errors and missing permissions

(void)	- serverModel:permissionDenied:forUser:inChannel:

(void)	- serverModelInvalidChannelNameError:

(void)	- serverModelModifySuperUserError:

(void)	- serverModelTextMessageTooLongError:

(void)	- serverModelTemporaryChannelError:

(void)	- serverModel:missingCertificateErrorForUser:

(void)	- serverModel:invalidUsernameErrorForName:

(void)	- serverModelChannelFullError:

(void)	- serverModelChannelNameError:

(void)	- serverModel:permissionDeniedForReason:

(void)	- serverModel:didReceiveAccessControl:forChannel:

Method Documentation

- (void) serverModel:	(MKServerModel *)	model
channelAdded:	(MKChannel *)	channel

Called when a new channel is added.

Parameters

model	The MKserverModel in which this event originated.
channel	The channel that was added.

- (void) serverModel:	(MKServerModel *)	model
channelDescriptionChanged:	(MKChannel *)	channel

Called when a channel description is changed.

Parameters

model	The MKServerModel in which this event originated.
channel	The channel whose description was changed.

- (void) serverModel:	(MKServerModel *)	model
channelMoved:	(MKChannel *)	channel

Called when a channel (and all of its subchannels, and users) is re-parented.

Parameters

model	The MKServerModel in which this event originated.
channel	The channel that was moved.

- (void) serverModel:	(MKServerModel *)	model
channelPositionChanged:	(MKChannel *)	channel

Called when a channel's position is changed.

Parameters

model	The MKServerModel in which this event originated.
channel	The channel whose position was changed.

- (void) serverModel:	(MKServerModel *)	model
channelRemoved:	(MKChannel *)	channel

Called when a channel is removed from the server.

Parameters

model	The MKServerModel in which this event originated.
channel	The channel that was removed.

- (void) serverModel:	(MKServerModel *)	model
channelRenamed:	(MKChannel *)	channel

Called when a channel is renamed.

Parameters

model	The MKServerModel in which this event originated.
channel	The channel that was renamed.

- (void) serverModel:	(MKServerModel *)	model
didReceiveAccessControl:	(MKAccessControl *)	accessControl
forChannel:	(MKChannel *)	channel

Called after an access control request

Parameters

model	The MKServerModel in which this event originated.
accessControl	The requested access control.
channel	The channel to which access control refers.

- (void) serverModel:	(MKServerModel *)	model
invalidUsernameErrorForName:	(NSString *)	name

Called when an action involving an invalid username occurs.

Parameters

model	The MKServerModel in which this error occurred.
name	The name that was deemed invalid by the server. May be nil.

- (void) serverModel:	(MKServerModel *)	model
joinedServerAsUser:	(MKUser *)	user

Called upon successfully authenticating with a server. This method is deprecated, see serverModel:joinedServerAsUser:withWelcomeMessage:.

Parameters

model	The MKServerModel object in which this event originated.
user	The MKUser object representing the local user.

- (void) serverModel:	(MKServerModel *)	model
joinedServerAsUser:	(MKUser *)	user
withWelcomeMessage:	(MKTextMessage *)	msg

Called upon successfully authenticating with a server.

Parameters

model	The MKServerModel object in which this event originated.
user	The MKUser object representing the local user.
msg	The welcome message presented by the server.

- (void) serverModel:	(MKServerModel *)	model
linksAdded:	(NSArray *)	newLinks
toChannel:	(MKChannel *)	channel

Called when new channels links are added to a channel.

Parameters

model	The MKServerModel in which this event originated.
newLinks	An array of channels that the channel was linked to.
channel	The channel that the links were added to.

- (void) serverModel:	(MKServerModel *)	model
linksChangedForChannel:	(MKChannel *)	channel

Called when a channel's links change.

Parameters

model	The MKServerModel in which this event originated.
channel	The channel whose links changed.

- (void) serverModel:	(MKServerModel *)	model
linksRemoved:	(NSArray *)	removedLinks
fromChannel:	(MKChannel *)	channel

Called when channel links are removed from a channel.

Parameters

model	The MKServerModel in which this event originated.
removedLinks	An array of channels that were unlinked from the channel.
channel	The channel that the links were removed from.

- (void) serverModel:	(MKServerModel *)	model
linksSet:	(NSArray *)	newLinks
forChannel:	(MKChannel *)	channel

Called when a complete list of links for a channel is receieved. (This happens mostly during initial connect).

Parameters

model	The MKServerModel in which this event originated.
newLinks	An array of channels whose links were changed.
channel	The channel for which newLinks were set for.

- (void) serverModel:	(MKServerModel *)	model
missingCertificateErrorForUser:	(MKUser *)	user

Called when a certificate is needed, but not persent, for a given operation.

Parameters

model	The MKServerModel in which the error occurred.
user	The user who did not have a certificate.

- (void) serverModel:	(MKServerModel *)	model
permissionDenied:	(MKPermission)	perm
forUser:	(MKUser *)	user
inChannel:	(MKChannel *)	channel

Called when a permission error occurred for a given channel for a given user.

Parameters

model	The MKServerModel in which this permission error occurred.
perm	The permission that was denied
user	The user for whom the permission was denied.
channel	The channel in which the permission was denied.

- (void) serverModel:	(MKServerModel *)	model
permissionDeniedForReason:	(NSString *)	reason

Called when a simple 'Permission denied.' message is sufficient to show to the user. Can include a reason. This kind of permission error is also used as a fallback, if the server detects that a client is using a too old version of the Mumble protocol to understand all error types.

Parameters

model	The MKServerModel in which this error occurred.
reason	The reason for the error. May be nil if no reason was given.

- (void) serverModel:	(MKServerModel *)	model
textMessageReceived:	(MKTextMessage *)	msg
fromUser:	(MKUser *)	user

Called whenever a text message is receieved.

Parameters

model	The MKServerModel in which this event originated.
msg	The MKTextMessage object representing the received text message.
user	The MKUser that sent the text message (nil if the message was sent by the server).

- (void) serverModel:	(MKServerModel *)	model
userAuthenticatedStateChanged:	(MKUser *)	user

Called when the user's authenticated flag changes.

Parameters

model	The MKServerModel in which this event originated.
user	The user whose authenticated flag changed.

- (void) serverModel:	(MKServerModel *)	model
userBanned:	(MKUser *)	user
byUser:	(MKUser *)	actor
forReason:	(NSString *)	reason

Called when a user is banned by another user (or the server). When a user is banned, he is also kicked from the server at the same time.

Parameters

model	The MKServerModel in which this event originated.
user	The user that was banned.
actor	The user that banned the other user. May be nil if the ban was initiated by the server.
reason	The reason for the ban.

- (void) serverModel:	(MKServerModel *)	model
userCommentChanged:	(MKUser *)	user

Called when a user's comment is changed.

Parameters

model	The MKServerModel in which this event originated.
user	The user whose comment was changed.

- (void) serverModel:	(MKServerModel *)	model
userDeafened:	(MKUser *)	user
byUser:	(MKUser *)	actor

Called when a user is deafened by another user.

Parameters

model	The MKServerModel in which this event originated.
user	The user who was deafened.
actor	The user who deafened the other user. May be nil if the user was deafened by the server.

- (void) serverModel:	(MKServerModel *)	model
userDisconnected:	(MKUser *)	user

Called when a user disconnects from the server.

Parameters

model	The MKServerModel in which this event originated.
user	The user that disconnected.

- (void) serverModel:	(MKServerModel *)	model
userJoined:	(MKUser *)	user

Called when a new user joins the server.

Parameters

model	The MKServerModel object in which this event originated.
user	The user who joined the server.

- (void) serverModel:	(MKServerModel *)	model
userKicked:	(MKUser *)	user
byUser:	(MKUser *)	actor
forReason:	(NSString *)	reason

Called when a user is kicked by another user (or the server).

Parameters

model	The MKServerModel in which this event originated.
user	The user that was kicked.
actor	The user that kicked the other user. May be nil if the server initiated the kick.
reason	The reason for kicking the user off the server.

- (void) serverModel:	(MKServerModel *)	model
userLeft:	(MKUser *)	user

Called when a user leaves the server.

Parameters

model	The MKServerModel in which this event originated.
user	The user that left the server.

- (void) serverModel:	(MKServerModel *)	model
userMoved:	(MKUser *)	user
toChannel:	(MKChannel *)	chan
byUser:	(MKUser *)	mover

Called when a user is moved to another channel. This is also called when a user changes the channel he resides in (in which case user is equivalent to mover).

In case the server initiated the move, the mover is nil.

Parameters

model	The MKServerModel object in which this event originated.
user	The user that was moved.
chan	The channel to which user was moved to.
mover	The user that performed the user move. If the move was performed by the server, mover is nil.

- (void) serverModel:	(MKServerModel *)	model
userMoved:	(MKUser *)	user
toChannel:	(MKChannel *)	chan
fromChannel:	(MKChannel *)	prevChan
byUser:	(MKUser *)	mover

Called when a user is moved to another channel. This is also called when a user changes the channel he resides in (in which case user is equivalent to mover).

In case the server initiated the move, the mover is nil.

Parameters

model	The MKServerModel object in which this event originated.
user	The user that was moved.
chan	The channel to which user was moved to.
prevChan	The channel from which the user was moved. (May be nil)
mover	The user that performed the user move. If the move was performed by the server, mover is nil.

- (void) serverModel:	(MKServerModel *)	model
userMuted:	(MKUser *)	user
byUser:	(MKUser *)	actor

Called when a user is muted by another user.

Parameters

model	The MKServerModel in which this event originated.
user	The user who was muted.
actor	The user who muted the other user. May be nil if the user was muted by the server.

- (void) serverModel:	(MKServerModel *)	model
userMutedAndDeafened:	(MKUser *)	user
byUser:	(MKUser *)	actor

Called when a user mutes-deafens another user.

Parameters

model	The MKServerModel in which this event originated.
user	The user who was mute-deafened.
actor	The user who initiated the mute-deafen action on the other user. May be nil if the server mute-deafened the user.

- (void) serverModel:	(MKServerModel *)	model
userMuteStateChanged:	(MKUser *)	user

Called when a user's mute state changes.

Parameters

model	The MKServerModel in which this event originated.
user	The user whose mute state changed.

- (void) serverModel:	(MKServerModel *)	model
userPrioritySpeakerChanged:	(MKUser *)	user

Called when a user's priorty speaker flag changes.

Parameters

model	The MKServerModel in which this event originated.
user	The user whose priority speaker flag changed.

- (void) serverModel:	(MKServerModel *)	model
userRecordingStateChanged:	(MKUser *)	user

Called when a user's recording flag changes.

Parameters

model	The MKServerModle in which this event originated.
user	The user whose recording flag changed.

- (void) serverModel:	(MKServerModel *)	model
userRemovedSelfMute:	(MKUser *)	user

Called when a user removes his self-mute status.

Parameters

model	The MKServerModel object in which this event originated.
user	The user who removed his self-mute status.

- (void) serverModel:	(MKServerModel *)	model
userRemovedSelfMuteAndDeafen:	(MKUser *)	user

Called when a user removes his self-mute-deafen status.

Parameters

model	The MKServerModel in which this event originated.
user	The user who removed his self-mute-deafen status.

- (void) serverModel:	(MKServerModel *)	model
userRenamed:	(MKUser *)	user

Called when a user is renamed.

Parameters

model	The MKServerModel object in which this event originated.
user	The user that was renamed.

- (void) serverModel:	(MKServerModel *)	model
userSelfMuted:	(MKUser *)	user

Called when a user self-mutes himself.

Parameters

model	The MKServerModel object in which this event originated.
user	The user who self-muted himself.

- (void) serverModel:	(MKServerModel *)	model
userSelfMutedAndDeafened:	(MKUser *)	user

Called when a user self-mute-deafens himself.

Parameters

model	The MKServerModel in which this event originated.
user	The user who self-muted and self-deafened himself.

- (void) serverModel:	(MKServerModel *)	model
userSelfMuteDeafenStateChanged:	(MKUser *)	user

Called by the MKServerModel when a user's self-mute-deafen status changes.

Parameters

model	The MKServerModel in which this event originated.
user	The user whose self-mute-deafen status changed.

- (void) serverModel:	(MKServerModel *)	model
userSuppressed:	(MKUser *)	user
byUser:	(MKUser *)	actor

Called when a user is suppressed by another user.

Parameters

model	The MKServerModel in which this event originated.
user	The user who was suppressed.
actor	The user who suppressed the other user. May be nil if the user was suppressed by the server.

- (void) serverModel:	(MKServerModel *)	model
userTalkStateChanged:	(MKUser *)	user

Called when the talk state of a user changes. This event is fired when the audio subsystem (MKAudio and its minions) notify the MKServerModel that audio data from a user on the connection handled by the server model is being played back.

Parameters

model	The MKServerModel object in which this event originated.
user	The user whose talk state changed.

- (void) serverModel:	(MKServerModel *)	model
userTextureChanged:	(MKUser *)	user

Called when a user's texture is changed.

Parameters

model	The MKServerModel in which this event originated.
user	The user whose texture was changed.

- (void) serverModel:	(MKServerModel *)	model
userUndeafened:	(MKUser *)	user
byUser:	(MKUser *)	actor

Called when a user is undeafened by another user.

Parameters

model	The MKServerModel in which this event originated.
user	The user who was undeafened.
actor	The user who undeafened the other user. May be nil if the user was undeafened by the server.

- (void) serverModel:	(MKServerModel *)	model
userUnmuted:	(MKUser *)	user
byUser:	(MKUser *)	actor

Called when a user is unmuted by another user.

Parameters

model	The MKServerModel in which this event originated.
user	The user who was unmuted.
actor	The user who unmuted the other user. May be nil if the user was unmuted by the server.

- (void) serverModel:	(MKServerModel *)	model
userUnmutedAndUndeafened:	(MKUser *)	user
byUser:	(MKUser *)	actor

Called when a user removes mute-deafen status from another user.

Parameters

model	The MKServerModel in which this event originated.
user	The user whose mute-deafen status was removed.
actor	The user who iniated the removal of the other user's mute-deafen status. May be nil if the server removed the mute-deafen status.

- (void) serverModel:	(MKServerModel *)	model
userUnsuppressed:	(MKUser *)	user
byUser:	(MKUser *)	actor

Called when a user is unsuppressed by another user.

Parameters

model	The MKServerModel in which this event originated.
user	The user who was unsuppressed.
actor	The user who unsuppresed the other user. May be nil if the user was unsupressed by the server.

- (void) serverModelChannelFullError: (MKServerModel *) model

Called when a channel user move operation failed because the destination channel was full. (Note: A joinChannel: also counts as a move operation.)

Parameters

model The MKServerModel in which this error occurred.

- (void) serverModelChannelNameError: (MKServerModel *) model

Called when a channel create operation failed because the channel name was invalid.

Parameters

model The MKServerModel in which this error occurred.

- (void) serverModelDisconnected: (MKServerModel *) model

Called when disconnected from the server (forcefully or not).

Parameters

model The MKServerModel object in which this event originated.

- (void) serverModelInvalidChannelNameError: (MKServerModel *) model

Called when a channel was attempted to be named or renamed to something which was not allowed by the server.

- (void) serverModelModifySuperUserError: (MKServerModel *) model

Called when an attempt to modify the SuperUser failed.

Parameters

model The MKServerModel in which the error occurred.

- (void) serverModelTemporaryChannelError: (MKServerModel *) model

Called when an action could not be performed on a temporary channel.

Parameters

model The MKServerModel in which the error occurred.

- (void) serverModelTextMessageTooLongError: (MKServerModel *) model

Called when the server received a text message that was too long.

Parameters

model The MKServerModel in which the error occurred.

The documentation for this protocol was generated from the following file:

/Users/mkrautz/Documents/mumble-iphoneos/MumbleKit/src/MumbleKit/MKServerModel.h

Instance Methods

Method Documentation