com.pubnub.api.PubnubInterface Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of pubnub-android-debug Show documentation

PubNub is a cross-platform client-to-client (1:1 and 1:many) push service in the cloud, capable of broadcasting real-time messages to millions of web and mobile clients simultaneously, in less than a quarter second!

The newest version!

package com.pubnub.api;

interface PubnubInterface {

    /**
     * This method unsets auth key.
     *
     */
    public void unsetAuthKey();

    /**
     * This method returns unique identifier.
     * 
     * @return Unique Identifier .
     */
    public String uuid();

    /**
     * This method sets auth key.
     *
     * @param authKey
     *            . 0 length string or null unsets auth key
     */
    public void setAuthKey(String authKey);

    /**
     * Sets domain value, default is "pubnub.com"
     *
     * @param domain
     *            Domain value
     */
    public void setDomain(String domain);

    /**
     * Sets origin value, default is "pubsub"
     *
     * @param origin
     *            Origin value
     */
    public void setOrigin(String origin);

    /**
     * Gets current UUID
     *
     * @return uuid current UUID value for Pubnub client
     */
    public String getUUID();

    /**
     * Returns domain
     * 
     * @return domain
     */
    public String getDomain();

    /**
     * This method returns auth key. Return null if not set
     *
     * @return Auth Key. null if auth key not set
     */
    public String getAuthKey();

    /**
     * Sets value for UUID
     *
     * @param uuid
     *            UUID value for Pubnub client
     */
    public void setUUID(String uuid);

}