Ovatar-iOS Documentation

Ovatar is the quickest and most powerful way to enable avatar support in any client. This documentation focuses on the iOS framework build in Objective C, but can be used in both Objective C and Swift projects. In this documentation, we will show you how to get avatar support in your app in minutes with our super simplified classes that require only a small amount of code. But we also will go into more detail as this framework can give you full control of all Ovatar features. Let's begin…

Registering

NOTE Ovatar is still in BETA so please let us know of any issues, also be aware that some aspects of the framework may change without notice. For this, we suggest using coccopods version control.

Setup

OR

by adding adding the project though Coccopods (Recommended)

pod 'Ovatar-iOS'

Getting Started

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;

}

Ovatar Icon (The Easy Way)

Adding the 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

add the OOvatarIcon framework

#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];
          

Let's get that Ovatar!

Querying by Key, Email Address or Phone Number

Ovatar allows you to query of course images uploaded using your app_key can be called with ease (the use of a key) but you can also query Ovatar images by Email Address or Phone Number and all can be achived by calling

Swift

Objective C

NOTE In addition to passing a query you can also add a 'name'. This will not query user by name but allow you to store the users name for reference in both the Ovatar Dashboard and for later reference when calling the an image.

NOTE passing an original image URL to originalImage will first migrate this image to ovatar. If you do don't want to migrate images please pass nil

Swift

Objective C

NOTE If you want to query both a key and a email address as fall back simply add this method multiple times.

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
	

NOTE Some users have reported this not working, this is because they called this before the OOvatarIcon was initialized. Please make sure you add OOvatarIcon to your project first!

Setting your own icon

In some cases you may have an avatar icon from another service you would like to use. To do so you can just call

Swift

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

Objective C

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

Manual Uploading

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];

NOTE Metadata is returned by querying the JSON output, this by directly calling the OOvatar class. See more below.

The Power of the OOvatarIcon

Placeholder

Editing

Only Faces

Image Editing

Animation

Additionally, for more control you can change the crossfade duration by setting crossfade = 1.0;. By deafult this is 0.6.

Full Preview

Additionally, you can set a custom caption in the full-screen view. This could be information about the user or just about anything. To add this setting previewcaption = "This is my Ovatar Caption"

Loader

Delegate Callbacks

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.
}

Debugging & Options

Name

Swift

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

Objective C

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

Debugging

Swift

OOvatar.sharedInstance().setDebugging(true)

Objective C

[[OOvatar sharedInstance] setDebugging:true];

Gravatar Support

Swift

OOvatar.sharedInstance().setGravatarFallback(false)

Objective C

[[OOvatar sharedInstance] setGravatarFallback:false];

Caching

Swift

Objective C