io.straas.android.sdk.messaging

Class User

java.lang.Object

io.straas.android.sdk.messaging.User

All Implemented Interfaces:

Parcelable

public final class User
extends Object
implements Parcelable

Provides necessary information of a person in a chatroom.

Nested Class Summary

Nested classes/interfaces inherited from interface android.os.Parcelable

Parcelable.ClassLoaderCreator<T>, Parcelable.Creator<T>

Field Summary

Fields

Modifier and Type	Field and Description
static Parcelable.Creator<User>	CREATOR
static int	USER_LABEL_NOT_EXIST

Fields inherited from interface android.os.Parcelable

CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	User(Parcel in, ClassLoader loader)

Method Summary

Modifier and Type	Method and Description
int	describeContents()
boolean	equals(Object obj) Compare if it's the same user.
String	getAvatar() Returns user avatar link.
Integer	getLabel() Returns user label.
String	getName() Returns user name
Role	getRole() Returns user role.
boolean	isGuest() Returns true if the user is a guest.
boolean	isOnline() Returns true if the user is online.
User	setName(String name) Sets name.
void	writeToParcel(Parcel dest, int flags)

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

USER_LABEL_NOT_EXIST

public static final int USER_LABEL_NOT_EXIST

See Also:

Constant Field Values

CREATOR

public static final Parcelable.Creator<User> CREATOR

Constructor Detail

User

protected User(Parcel in,
               ClassLoader loader)

Method Detail

writeToParcel

public void writeToParcel(Parcel dest,
                          int flags)

Specified by:

writeToParcel in interface Parcelable

getAvatar

public String getAvatar()

Returns user avatar link.

Returns:

Avatar link.

getName

public String getName()

Returns user name

Returns:

User name.

getLabel

public Integer getLabel()

Returns user label.

Label is a system-generated chat-wide unique id of a user. Notice that it's only unique in the same chatroom.

Returns:

User label.

isGuest

public boolean isGuest()

Returns true if the user is a guest.

getRole

public Role getRole()

Returns user role.

Returns:

User role.

isOnline

public boolean isOnline()

Returns true if the user is online.

setName

public User setName(String name)

Sets name. Notice that this method just changes the user name in client side.

Parameters:

name - name

Returns:

user

describeContents

public int describeContents()

Specified by:

describeContents in interface Parcelable

equals

public boolean equals(Object obj)

Compare if it's the same user. Notice that the obj should be a User in the same chat room.

The same user means they have same user label in a chatroom.

Overrides:

equals in class Object

Parameters:

obj - User to compare.

Returns:

True if it's the same user.