Ovatar-iOS 文档

Ovatar 是在客户端中启用头像支持最快、最强大的方式。本文档重点关注内置于 Objective C 的 iOS 框架，但也可以用于 Objective C 和 Swift 项目。在这个文档中，我们将向您展示如何通过我们的超级简化类，只需少量代码即可在几分钟内使您的应用程序获得头像支持。但我们也将进一步详细说明，因为这个框架可以为您提供所有 Ovatar 功能的完全控制权。让我们开始吧…

注册

注意 Ovatar 仍在 BETA 测试中，所以请在遇到任何问题时告诉我们，并且请注意，框架的一些方面可能会在不通知的情况下更改。因此，我们建议使用 coccopods 版本控制。

设置

或者

通过 Coccopods 添加项目（推荐）

pod 'Ovatar-iOS'

入门

Swift

func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey : Any]? = nil) -> Bool {
    OOvatar.sharedInstance(withAppKey: "app_key")
    OOvatar.sharedInstance().setDebugging(true)
    return true
}

Objective C

-(BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
	[OOvatar sharedInstanceWithAppKey:@"app_key"];
    [[OOvatar sharedInstance] setDebugging:true];
return true;

}

头像图标（简单方式）

添加 OvatarIcon

Swift

import OOvatarIcon

var ovatar: OOvatarIcon?

	ovatar = OOvatarIcon(frame: CGRect(x: (bounds.size.width / 2) - 100.0, y: (bounds.size.height / 2) - 100.0, width: 200.0, height: 200.0))
    ovatar?.placeholder = UIImage(named: "a_custom_placeholder_image")
    ovatar?.oicondelegate = self
    ovatar?.hasaction = true
    ovatar?.preview = false
    ovatar?.allowsphotoediting = true
    ovatar?.onlyfaces = false
    addSubview(headerOvatar)
    ovatar?.imageDownload(withQuery: "[email protected]")

Objective C

添加 OOvatarIcon 框架

#import "OOvatarIcon/OOvatarIcon.h"

@property (nonatomic, strong) OOvatarIcon *ovatar;

.m

     self.ovatar = [[OOvatarIcon alloc] initWithFrame:CGRectMake((self.bounds.size.width / 2) - 100.0, (self.bounds.size.height / 2) - 100.0, 200.0, 200.0)];
     self.ovatar.placeholder = [UIImage imageNamed:@"a_custom_placeholder_image"];
     self.ovatar.oicondelegate = self;
     self.ovatar.hasaction = true;
     self.ovatar.preview = false;    
     self.ovatar.allowsphotoediting = true;
     self.ovatar.onlyfaces = false;     
     [self addSubview:self.headerOvatar];
          

让我们获取那个 Ovatar！

通过关键字、电子邮件地址或电话号码查询

Ovatar 允许您轻松查询使用 app_key 上传的图像（键的使用），但您也可以通过 电子邮件地址 或 电话号码 查询 Ovatar 图像，所有这些都可以通过调用实现。

Swift

Objective C

注意 除了传递查询之外，您还可以添加一个 'name'。这不会通过名称查询用户，但允许您存储用户姓名以供参考，既在 Ovatar 控板 中，也可以在未来调用图像时进行参考。

注意 向 originalImage 传递原始图像 URL 会首先将此图像迁移到 Ovatar。如果您不想迁移图像，请传递 nil。

Swift

Objective C

注意 如果你希望查询键和电子邮件地址作为后备，请多次添加此方法。

Swift

		ovatar?.imageDownload(withQuery: "[email protected]") //email address query
        ovatar?.imageDownload(withQuery: "+44000000000000")//uk phone number query
        ovatar?.imageDownload(withQuery: "my_uploaded_ovatar_key")//query by key
	

Objective C

		
		[self.ovatar imageDownloadWithQuery:@"[email protected]"];  //email address query
		[self.ovatar imageDownloadWithQuery:@"+44000000000000"];  //uk phone number query
		[self.ovatar imageDownloadWithQuery:@"my_uploaded_ovatar_key"]; //query by key
	

注意 一些用户报告说这不起作用，这是因为他们在初始化 OOvatarIcon 之前调用了它。请确保您首先将 OOvatarIcon 添加到您的项目。

设置您自己的图标

在某些情况下，您可能需要使用来自其他服务的一个头像图标。为此，您可以简单调用

Swift

ovatar?.imageSet(UIImage(named: "my_local_image.png"), animated: true)

Objective C

[self.ovatar imageSet:[UIImage imageNamed:@"my_local_image.png"] animated:TRUE]

手动上传

Swift

 let imagedata = .uiImageJPEGRepresentation() as? Data
 let metadata = ["copyright": "joe barbour"]
 ovatar?.imageUpdate(withImage: imagedata, info: nil)	

Objective C

NSData *imagedata = UIImageJPEGRepresentation([UIImage imageNamed:@"my_selected_image.jpg"], 0.8);
NSDictionary *metadata = @{@"copyright":@"joe barbour"};
[self.ovatar imageUpdateWithImage:imagedata info:nil];

注意 通过查询 JSON 输出可以返回元数据，这是通过直接调用 OOvatar 类来实现的。下面将做进一步说明。

OOvatarIcon 的强大功能

占位符

编辑

仅人脸

图片编辑

动画

此外，为了更好地控制，您可以修改交叉淡入淡出的持续时间，将其设置为crossfade = 1.0;。默认情况下，这是0.6。

完整预览

此外，您还可以在全屏视图中设置自定义标题。这可以是对用户的信息，或者任何其他内容。要添加此设置，请在代码中添加 previewcaption = "This is my Ovatar Caption"

加载器

委托回调

Swift

func ovatarIconWasTapped(withGesture gesture: UITapGestureRecognizer?) {
    //Called if the 'presentpicker' BOOL is set to FALSE (by default it is set to TRUE). Here you can set custom actions for the when the Ovatar Icon is tapped.
}

func ovatarIconWasUpdatedSucsessfully(_ output: [AnyHashable: Any]?) {
    //Called if an image is uploaded successfully.
}

func ovatarIconUploadFailed() throws {
    //Called if an image cannot be uploaded, see the documentation for error codes.
}

func ovatarIconUploading(withProgress progress: Float) {
    //Called everytime the progress of the upload changes. The progress with displayed as in double value on a 0-100 scale.
}

Objective-C

-(void)ovatarIconWasTappedWithGesture:(UITapGestureRecognizer *)gesture {
    //Called if the 'presentpicker' BOOL is set to FALSE (by default it is set to TRUE). Here you can set custom actions for the when the Ovatar Icon is tapped.
}   

-(void)ovatarIconWasUpdatedSucsessfully:(NSDictionary *)output {
    //Called if an image is uploaded successfully.
}

-(void)ovatarIconUploadFailedWithErrors:(NSError *)error {
    //Called if an image cannot be uploaded, see the documentation for error codes.
}

-(void)ovatarIconUploadingWithProgress:(float)progress {
    //Called everytime the progress of the upload changes. The progress with displayed as in double value on a 0-100 scale.
}

调试与选项

名称

Swift

OOvatar.sharedInstance().setName("Steve Jobs")

Objective-C

[[OOvatar sharedInstance] setName:@"Steve Jobs"];

调试

Swift

OOvatar.sharedInstance().setDebugging(true)

Objective-C

[[OOvatar sharedInstance] setDebugging:true];

Gravatar 支持

Swift

OOvatar.sharedInstance().setGravatarFallback(false)

Objective C

[[OOvatar sharedInstance] setGravatarFallback:false];

缓存

Swift

Objective C