blob: 700581b2501093224bf6e712cd54aff6a3c401e6 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
|
// Copyright 2010-2012 The MumbleKit Developers. All rights reserved.
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.
@class MKUser;
/// @class MKChannel MKChannel.h MumbleKit/MKChannel.h
///
/// 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.
@interface MKChannel : NSObject
/// Returns the channel's channel ID.
- (NSUInteger) channelId;
/// Returns the channel's name.
- (NSString *) channelName;
/// Returns whether or not the channel is temporary.
///
/// @returns Returns YES if the channel is temporary. Returns NO if the channel is permanent.
- (BOOL) isTemporary;
/// Returns the position of the channel.
- (NSInteger) position;
/// Returns the channel's parent.
///
/// @returns The MKChannel object representing the channel's parent.
/// Returns nil if the current channel is the root channel.
- (MKChannel *) parent;
/// Returns an NSArray of the channel's subchannels represented as MKChannels.
- (NSArray *) channels;
/// Returns an NSArray of all users in the channel. The users are represented as MKUsers.
- (NSArray *) users;
/// Returns an NSArray of all channels linked to this channel.
- (NSArray *) linkedChannels;
/// Checks whether a given channel is linked to the receiving channel.
///
/// @param channel The channel whose link status should be checked.
///
/// @returns Returns YES if the receiving channel is linked to channel.
/// Otherwise, returns NO.
- (BOOL) isLinkedToChannel:(MKChannel *)channel;
/// Returns a channel's description hash. (On most server implementations, this
/// is a SHA1 digest).
- (NSData *) channelDescriptionHash;
/// Returns the channel's description.
- (NSString *) channelDescription;
@end
|
