com.pusher.client.channel.PresenceChannel Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of pusher-java-client Show documentation

This is a Java client library for Pusher, targeted at core Java and Android.

There is a newer version: 2.4.4

package com.pusher.client.channel;

import java.util.Set;

/**
 * An object that represents a Pusher presence channel. An implementation of
 * this interface is returned when you call
 * {@link com.pusher.client.Pusher#subscribePresence(String)} or
 * {@link com.pusher.client.Pusher#subscribePresence(String, PresenceChannelEventListener, String...)}
 * .
 */
public interface PresenceChannel extends PrivateChannel {

    /**
     * Gets a set of users currently subscribed to the channel.
     *
     * @return The users.
     */
    Set getUsers();

    /**
     * Gets the user that represents the currently connected client.
     *
     * @return A user.
     */
    User getMe();
}