Skip to content

[core] Presence: add isActive() to check if user is online and can answer #693

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
stokito wants to merge 1 commit into
base: master
Choose a base branch
from
Open

[core] Presence: add isActive() to check if user is online and can answer #693

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 15 additions & 1 deletion smack-core/src/main/java/org/jivesoftware/smack/packet/Presence.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,8 @@ public Presence(Presence other) {
* equivalent to <code>getType() == Presence.Type.available</code>. Note that even
* when the user is available, their presence mode may be {@link Mode#away away},
* {@link Mode#xa extended away} or {@link Mode#dnd do not disturb}. Use
* {@link #isAway()} to determine if the user is away.
* {@link #isAway()} to determine if the user is away, or {@link #isActive()}
* to determine if user is available an not away.
*
* @return true if the presence type is available.
*/
Expand All @@ -129,6 +130,19 @@ public boolean isAway() {
return type == Type.available && (mode == Mode.away || mode == Mode.xa || mode == Mode.dnd);
}

/**
* Returns true if the presence signals availability ({@link #isAvailable()}) and no away mode ({@link #isAway()}). Otherwise, returns false.
* mode is {@link Mode#available available}, or {@link Mode#chat ready to chat}. False will be returned when the type or mode
* is any other value, including when the presence type is unavailable (offline).
* This is a convenience method equivalent to
* <code>isAvailable() &amp;&amp; !isAway()</code>.
*
* @return true if the presence type is available and the presence mode is available or chat.
*/
public boolean isActive() {
return isAvailable() && !isAway();
}

@Override
public Type getType() {
return type;
Expand Down
2 changes: 2 additions & 0 deletions smack-core/src/test/java/org/jivesoftware/smack/packet/PresenceTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -172,9 +172,11 @@ public void isModeAwayTest() {
PresenceBuilder presence = getNewPresence();
presence.setMode(Presence.Mode.away);
assertTrue(presence.build().isAway());
assertFalse(presence.build().isActive());

presence.setMode(Presence.Mode.chat);
assertFalse(presence.build().isAway());
assertTrue(presence.build().isActive());
}

@Test
Expand Down