com.microstrategy.usher

Class InboxEntity.SenderEntity

java.lang.Object

com.microstrategy.usher.InboxEntity.SenderEntity

Enclosing class:

InboxEntity

public abstract static class InboxEntity.SenderEntity
extends java.lang.Object

The InboxEntity.SenderEntity abstract class wraps various properties related to the sender of an InboxEntity, including badge ID, name, and title, among others.

Method Summary

Modifier and Type	Method and Description
abstract int	badgeId() Returns an int of the identification number of the badge.
abstract java.lang.String	imageUrl() Returns a String of the URL of the profile photo of the sender.
abstract java.lang.String	initial() Returns a String of the initials of the sender.
abstract java.lang.String	name() Returns a String of the name of the sender.
abstract java.lang.String	orgName() Returns a String of the name of the organization.
abstract java.lang.String	title() Returns a String of the title of the sender.

Methods inherited from class java.lang.Object

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

Method Detail

badgeId

public abstract int badgeId()

Returns an int of the identification number of the badge.

Returns:

the identification number of the badge.

name

public abstract java.lang.String name()

Returns a String of the name of the sender.

Returns:

the name of the sender.

initial

public abstract java.lang.String initial()

Returns a String of the initials of the sender. This is used if the server does not contain an image for the sender; a placeholder of the sender's initials will be used instead.

Returns:

the initials of the sender.

imageUrl

public abstract java.lang.String imageUrl()

Returns a String of the URL of the profile photo of the sender.

Returns:

the URL of the profile photo of the sender.

orgName

@Nullable
public abstract java.lang.String orgName()

Returns a String of the name of the organization. May be null.

Returns:

the name of the organization.

title

@Nullable
public abstract java.lang.String title()

Returns a String of the title of the sender. May be null.

Returns:

the title of the sender.