# UserPortraitScreenlet for iOS

## Requirements

- XCode 6.3 or above
- iOS 8 SDK
- Liferay Portal 6.2 CE or EE

## Compatibility

- iOS 7 and above

## Features

The `UserPortraitScreenlet` shows the user's portrait from Liferay Portal. If the user doesn't have a portrait configured, a placeholder image is shown.

## Module

- None

## Themes

- Default
- Flat7

![The UserPortraitScreenlet using the Default and Flat7 themes.](Images/portrait.png)

## Portal Configuration

None

## Attributes

| Attribute | Data type | Explanation |
|-----------|-----------|-------------| 
| `borderWidth` | `number` | The size in pixels for the portrait's border. The default value is 1. Set this to 0 if you want to hide the border.|
|  `borderColor` | `UIColor` | The border's color. Use the system's transparent color to hide the border. |
|  `editable` | `boolean` | Lets the user change the portrait image by taking a photo or selecting a gallery picture. Default value is `false`. Portraits loaded with method `load(portraitId, uuid, male)` won't be able to be editable.|

## Methods

| Method | Return | Explanation |
|-----------|-----------|-------------| 
|  `loadLoggedUserPortrait()` | `boolean` | Starts the request to load the currently logged in user's portrait image (see the `SessionContext` class). |
|  `load(userId)` | `boolean` | Starts the request to load the specified user's  portrait image. |
|  `load(portraitId, uuid, male)` | `boolean` | Starts the request to load the portrait image using the specified user's data. The parameters `portraitId` and `uuid` can be retrieved by using the `SessionContext.userAttribute()` method.|
|  `load(userId)` | `boolean` | Starts the request to load the portrait image using the `userId`.|
|  `load(companyId, emailAddress)` | `boolean` | Starts the request to load the portrait image using the user's email address.|
|  `load(companyId, screenName)` | `boolean` | Starts the request to load the portrait image using the user's screen name.|

## Delegate

The `UserPortraitScreenlet` delegates some events to an object that conforms to the `UserPortraitScreenletDelegate ` protocol. This protocol lets you implement the following methods:

- `- screenlet:onUserPortraitResponseImage:`: Called when an image is received from the server. You can then apply image filters (grayscale, for example) and return the new image. You can return the original image supplied as the argument if you don't want to modify it.
- `- screenlet:onUserPortraitError:`: Called when an error occurs in the process. The `NSError` object describes the error.
- `- screenlet:onUserPortraitUploaded:`: Called when a new portrait is uploaded to the server. You receive the user attributes as a parameter.
- `- screenlet:onUserPortraitUploadError:`: Called when an error occurs in the upload process. The `NSError` object describes the error.