ymsg.network
Class YahooIdentity

Object
  YahooIdentity

public class YahooIdentity

extends Object

Represents an alias to the current Yahoo account.

A list of possible aliases (identities) is given to the session as part of the login process. The list can be accessed at any time from the getIdentities method of a current Session object. Typically this list is made available to an end user via some sort of menu. Clients would use the YahooIdentity associated with the choosen menu item when calling methods on the Session overloaded to take an identity.

The order in which identities appear in the list may change from login to login. Indeed even during a session, if the user's data is refreshed, there is a (slim) possibility they may change order.

Since:

1.0

Constructor Summary

YahooIdentity()

Method Summary

String	getId() Returns this identity's username.
boolean	isActivated() Returns true if this identity is currently activated.
boolean	isLoginIdentity() Returns true if this is the login identity.
boolean	isPrimaryIdentity() Returns true if this is the primary identity.
String	toString() Returns a string representation of this object.

Methods inherited from class Object

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

Constructor Detail

YahooIdentity

public YahooIdentity()

Method Detail

getId

public String getId()

Returns this identity's username.

Returns:

identity string

Since:

1.0

isPrimaryIdentity

public boolean isPrimaryIdentity()

Returns true if this is the primary identity. The primary identity is the original, true, identity. All other identities are aliases to the primary identity.

Returns:

true if object is user's primary identity

Since:

1.0

isLoginIdentity

public boolean isLoginIdentity()

Returns true if this is the login identity. The login identity is the username used with the Session.login method to create the current session.

Returns:

true if object is user's login identity

Since:

1.0

isActivated

public boolean isActivated()

Returns true if this identity is currently activated. Activated identities are visible to the network, while deactivated identities appear as if they are off-line.

Returns:

true if the identity is active

Since:

1.0

toString

public String toString()

Returns a string representation of this object.

Returns:

object as a string