JSQMessagesAvatarImage Class Reference

#import <JSQMessagesAvatarImage.h>

Inheritance diagram for JSQMessagesAvatarImage:

Instance Methods
(instancetype)	- initWithAvatarImage:highlightedImage:placeholderImage:
Instance Methods inherited from <JSQMessageAvatarImageDataSource>
(UIImage *)	- avatarImage
(UIImage *)	- avatarHighlightedImage
(UIImage *)	- avatarPlaceholderImage

Class Methods
(instancetype)	+ avatarWithImage:
(instancetype)	+ avatarImageWithPlaceholder:

Properties
UIImage *	avatarImage
UIImage *	avatarHighlightedImage
UIImage *	avatarPlaceholderImage

Detailed Description

A JSQMessagesAvatarImage model object represents an avatar image. This is a concrete class that implements the JSQMessageAvatarImageDataSource protocol. It contains a regular avatar image, a highlighted avatar image, and a placeholder avatar image.

See also

JSQMessagesAvatarImageFactory.

Method Documentation

+ (instancetype) avatarImageWithPlaceholder:

(UIImage *)

placeholderImage

Initializes and returns an avatar image object having the specified placeholder image.

Parameters

placeholderImage

The placeholder image for this avatar image. This value must not be nil.

Returns

An initialized JSQMessagesAvatarImage object if successful, nil otherwise.

+ (instancetype) avatarWithImage:

(UIImage *)

image

Initializes and returns an avatar image object having the specified image.

Parameters

image

The image for this avatar image. This image will be used for the all of the following properties: avatarImage, avatarHighlightedImage, avatarPlaceholderImage; This value must not be nil.

Returns

An initialized JSQMessagesAvatarImage object if successful, nil otherwise.

- (instancetype) initWithAvatarImage:		(UIImage *)	avatarImage
highlightedImage:		(UIImage *)	highlightedImage
placeholderImage:		(UIImage *)	placeholderImage

Initializes and returns an avatar image object having the specified regular, highlighed, and placeholder images.

Parameters

avatarImage	The avatar image for a regular display state.
highlightedImage	The avatar image for a highlighted display state.
placeholderImage	The placeholder image for this avatar image. This value must not be nil.

Returns

An initialized JSQMessagesAvatarImage object if successful, nil otherwise.

Property Documentation

- (UIImage*) avatarHighlightedImage

readwritenonatomicstrong

The avatar image for a highlighted display state.

- (UIImage*) avatarImage

readwritenonatomicstrong

The avatar image for a regular display state.

- (UIImage*) avatarPlaceholderImage

readnonatomicstrong

Returns the placeholder image for an avatar to display if avatarImage is nil.

---

The documentation for this class was generated from the following files:

• Vendors/JSQMessagesViewController/Model/JSQMessagesAvatarImage.h
• Vendors/JSQMessagesViewController/Model/JSQMessagesAvatarImage.m