|
MumbleKit
|
#import <MumbleKit/MKChannel.h>
Instance Methods | |
| (NSUInteger) | - channelId |
| Returns the channel's channel ID. | |
| (NSString *) | - channelName |
| Returns the channel's name. | |
| (BOOL) | - isTemporary |
| (NSInteger) | - position |
| Returns the position of the channel. | |
| (MKChannel *) | - parent |
| (NSArray *) | - channels |
| Returns an NSArray of the channel's subchannels represented as MKChannels. | |
| (NSArray *) | - users |
| Returns an NSArray of all users in the channel. The users are represented as MKUsers. | |
| (NSArray *) | - linkedChannels |
| Returns an NSArray of all channels linked to this channel. | |
| (BOOL) | - isLinkedToChannel: |
| (NSData *) | - channelDescriptionHash |
| (NSString *) | - channelDescription |
| Returns the channel's description. | |
MKChannel represents a channel on a Mumble server. MKChannel objects are owned by their respective MKServerModel instances.
The object's MKServerModel may change properties of the channel at any time, but all changes are serialized to the main thread.
Generally, as a consumer of this API, most accesses to MKChannel happen in response to MKServerModelDelegate callbacks, and all calls to delegate methods of MKServerModel are ensured to happen on the same thread that modifies MKChannle objects.
Thus, if all inspection of the MKChannel's properties happen in response to MKServerModelDelegate callbacks, everything should be OK.
| - (NSData *) channelDescriptionHash |
Returns a channel's description hash. (On most server implementations, this is a SHA1 digest).
| - (BOOL) isLinkedToChannel: | (MKChannel *) | channel |
Checks whether a given channel is linked to the receiving channel.
| channel | The channel whose link status should be checked. |
| - (BOOL) isTemporary |
Returns whether or not the channel is temporary.
| - (MKChannel *) parent |
Returns the channel's parent.
1.8.2
