001package com.pusher.client.channel;
002
003import java.util.Set;
004
005/**
006 * An object that represents a Pusher presence channel. An implementation of
007 * this interface is returned when you call
008 * {@link com.pusher.client.Pusher#subscribePresence(String)} or
009 * {@link com.pusher.client.Pusher#subscribePresence(String, PresenceChannelEventListener, String...)}
010 * .
011 */
012public interface PresenceChannel extends PrivateChannel {
013
014    /**
015     * Gets a set of users currently subscribed to the channel.
016     *
017     * @return The users.
018     */
019    Set<User> getUsers();
020
021    /**
022     * Gets the user that represents the currently connected client.
023     *
024     * @return A user.
025     */
026    User getMe();
027}