root/Trunk/Adium.framework/Versions/A/Headers/AIChat.h @ 2

/* 
 * Adium is the legal property of its developers, whose names are listed in the copyright file included
 * with this source distribution.
 * 
 * This program is free software; you can redistribute it and/or modify it under the terms of the GNU
 * General Public License as published by the Free Software Foundation; either version 2 of the License,
 * or (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even
 * the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General
 * Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License along with this program; if not,
 * write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 */

#import <Adium/ESObjectWithProperties.h>
#import <Adium/AIContentTyping.h>
#import <Adium/AIListObject.h>
#import <Adium/AIInterfaceControllerProtocol.h>

@class AIAccount, AIListObject, AIListContact, AIContentObject, AIEmoticon;

#define Chat_OrderDidChange                                             @"Chat_OrderDidChange"
#define Chat_WillClose                                                  @"Chat_WillClose"
#define Chat_DidOpen                                                    @"Chat_DidOpen"
#define Chat_BecameActive                                               @"Chat_BecameActive"
#define Chat_AttributesChanged                                  @"Chat_AttributesChanged"
#define Chat_StatusChanged                                              @"Chat_StatusChagned"
#define Chat_ParticipatingListObjectsChanged    @"Chat_ParticipatingListObjectsChanged"
#define Chat_SourceChanged                                              @"Chat_SourceChanged"
#define Chat_DestinationChanged                                 @"Chat_DestinationChanged"

#define KEY_UNVIEWED_CONTENT    @"UnviewedContent"
#define KEY_TYPING                              @"Typing"

#define KEY_CHAT_TIMED_OUT              @"Timed Out"
#define KEY_CHAT_CLOSED_WINDOW  @"Closed Window"

typedef enum {
        AIChatTimedOut = 0,
        AIChatClosedWindow
} AIChatUpdateType;

typedef enum {
        AIChatCanNotSendMessage = 0,
        AIChatMayNotBeAbleToSendMessage,
        AIChatCanSendMessageNow,
        AIChatCanSendViaServersideOfflineMessage
} AIChatSendingAbilityType;

#define KEY_ENCRYPTED_CHAT_PREFERENCE   @"Encrypted Chat Preference"
#define GROUP_ENCRYPTION                                @"Encryption"

typedef enum {
        EncryptedChat_Default = -2, /* For use by a menu which wants to provide a 'no preference' option */
        EncryptedChat_Never = -1,
        EncryptedChat_Manually = 0, /* Manually is the default */
        EncryptedChat_Automatically = 1, 
        EncryptedChat_RejectUnencryptedMessages = 2
} AIEncryptedChatPreference;

typedef enum {
        EncryptionStatus_None = 0,
        EncryptionStatus_Unverified,
        EncryptionStatus_Verified,
        EncryptionStatus_Finished
} AIEncryptionStatus;

//Chat errors should be indicated by setting a property on this key 
//with an NSNumber of the appropriate error type as its object
#define KEY_CHAT_ERROR                  @"Chat Error"

//This key may be set before sending KEY_CHAT_ERROR to provide any data the
//the error message should make use of.  It may be of any type.
#define KEY_CHAT_ERROR_DETAILS  @"Chat Error Details"

typedef enum {
        AIChatUnknownError = 0,
        AIChatMessageSendingUserIsBlocked,
        AIChatMessageSendingNotAllowedWhileInvisible,
        AIChatMessageSendingUserNotAvailable,
        AIChatMessageSendingTooLarge,
        AIChatMessageSendingTimeOutOccurred,
        AIChatMessageSendingConnectionError,
        AIChatMessageSendingMissedRateLimitExceeded,
        AIChatMessageReceivingMissedTooLarge,
        AIChatMessageReceivingMissedInvalid,
        AIChatMessageReceivingMissedRateLimitExceeded,
        AIChatMessageReceivingMissedRemoteIsTooEvil,
        AIChatMessageReceivingMissedLocalIsTooEvil,
        AIChatCommandFailed,
        AIChatInvalidNumberOfArguments
} AIChatErrorType;

@interface AIChat : ESObjectWithProperties <AIContainingObject> {
    AIAccount                   *account;
        NSDate                          *dateOpened;
        BOOL                            isOpen;
        BOOL                            isGroupChat;
        BOOL                            hasSentOrReceivedContent;

        NSMutableArray          *pendingOutgoingContentObjects;

    NSMutableArray              *participatingListObjects;
        AIListContact           *preferredListObject;
        NSString                        *name;
        NSString                        *uniqueChatID;
        id                                      identifier;
        
        NSMutableSet            *ignoredListContacts;
        
        BOOL                            expanded;                       //Exanded/Collapsed state of this object
        
        BOOL                            enableTypingNotifications;
        
        NSMutableSet            *customEmoticons;
        
        
}

+ (id)chatForAccount:(AIAccount *)inAccount;

- (AIAccount *)account;
- (void)setAccount:(AIAccount *)inAccount;
- (void)accountDidJoinChat;

- (NSDate *)dateOpened;
- (NSDictionary *)chatCreationDictionary;
- (void)setChatCreationDictionary:(NSDictionary *)inDict;

- (BOOL)isOpen;
- (void)setIsOpen:(BOOL)flag;

- (BOOL)hasSentOrReceivedContent;
- (void)setHasSentOrReceivedContent:(BOOL)flag;

- (int)unviewedContentCount;
- (void)incrementUnviewedContentCount;
- (void)clearUnviewedContentCount;

- (void)setDisplayName:(NSString *)inDisplayName;

- (void)addParticipatingListObject:(AIListContact *)inObject notify:(BOOL)notify;
- (void)removeAllParticipatingContactsSilently;
- (AIListContact *)listObject;
- (void)setListObject:(AIListContact *)inObject;
- (AIListContact *)preferredListObject;
- (void)setPreferredListObject:(AIListContact *)inObject;
- (BOOL)inviteListContact:(AIListContact *)inObject withMessage:(NSString *)inviteMessage;

- (BOOL)shouldBeginSendingContentObject:(AIContentObject *)inObject;
- (void)finishedSendingContentObject:(AIContentObject *)inObject;

- (NSString *)name;
- (void)setName:(NSString *)inName;

- (id)identifier;
- (void)setIdentifier:(id)inIdentifier;

- (NSString *)uniqueChatID;

- (NSImage *)chatImage;
- (NSImage *)chatMenuImage;

- (void)setSecurityDetails:(NSDictionary *)securityDetails;
- (NSDictionary *)securityDetails;
- (BOOL)isSecure;
- (AIEncryptionStatus)encryptionStatus;
- (BOOL)supportsSecureMessagingToggling;

- (AIChatSendingAbilityType)messageSendingAbility;
- (BOOL)canSendImages;

- (BOOL)isListContactIgnored:(AIListObject *)inContact;
- (void)setListContact:(AIListContact *)inContact isIgnored:(BOOL)isIgnored;

- (BOOL)isGroupChat;
- (void)setIsGroupChat:(BOOL)flag;

- (void)addCustomEmoticon:(AIEmoticon *)inEmoticon;
- (NSSet *)customEmoticons;

- (void)receivedError:(NSNumber *)type;

- (id <AIChatContainer>)chatContainer;

- (NSMenu *)actionMenu;

@end