PNXMPPFramework/Extensions/XEP-0153/XMPPvCardAvatarModule.h
2016-02-24 16:56:39 +01:00

94 lines
2.6 KiB
Objective-C

//
// XMPPvCardAvatarModule.h
// XEP-0153 vCard-Based Avatars
//
// Created by Eric Chamberlain on 3/9/11.
// Copyright 2011 RF.com. All rights reserved.
/*
* NOTE: Currently this implementation only supports downloading and caching avatars.
*/
#import <Foundation/Foundation.h>
#if TARGET_OS_IPHONE
#import <UIKit/UIKit.h>
#else
#import <Cocoa/Cocoa.h>
#endif
#import "XMPP.h"
#import "XMPPvCardTempModule.h"
#define _XMPP_VCARD_AVATAR_MODULE_H
@protocol XMPPvCardAvatarStorage;
@interface XMPPvCardAvatarModule : XMPPModule <XMPPvCardTempModuleDelegate>
{
__strong XMPPvCardTempModule *_xmppvCardTempModule;
__strong id <XMPPvCardAvatarStorage> _moduleStorage;
BOOL _autoClearMyvcard;
}
@property(nonatomic, strong, readonly) XMPPvCardTempModule *xmppvCardTempModule;
/*
* XEP-0153 Section 4.2 rule 1
*
* A client MUST NOT advertise an avatar image without first downloading the current vCard.
* Once it has done this, it MAY advertise an image.
*
* Default YES
*/
@property(nonatomic, assign) BOOL autoClearMyvcard;
- (id)initWithvCardTempModule:(XMPPvCardTempModule *)xmppvCardTempModule;
- (id)initWithvCardTempModule:(XMPPvCardTempModule *)xmppvCardTempModule dispatchQueue:(dispatch_queue_t)queue;
- (NSData *)photoDataForJID:(XMPPJID *)jid;
@end
////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
#pragma mark -
////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
@protocol XMPPvCardAvatarDelegate <NSObject>
#if TARGET_OS_IPHONE
- (void)xmppvCardAvatarModule:(XMPPvCardAvatarModule *)vCardTempModule
didReceivePhoto:(UIImage *)photo
forJID:(XMPPJID *)jid;
#else
- (void)xmppvCardAvatarModule:(XMPPvCardAvatarModule *)vCardTempModule
didReceivePhoto:(NSImage *)photo
forJID:(XMPPJID *)jid;
#endif
@end
////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
#pragma mark -
////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
@protocol XMPPvCardAvatarStorage <NSObject>
- (NSData *)photoDataForJID:(XMPPJID *)jid xmppStream:(XMPPStream *)stream;
- (NSString *)photoHashForJID:(XMPPJID *)jid xmppStream:(XMPPStream *)stream;
/**
* Clears the vCardTemp from the store.
* This is used so we can clear any cached vCardTemp's for the JID.
**/
- (void)clearvCardTempForJID:(XMPPJID *)jid xmppStream:(XMPPStream *)stream;
@end