com.anrisoftware.simplerest.ocs.ShareResult Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of simplerest-owncloud-ocs Show documentation

Access Owncloud OCS via REST API.

The newest version!

/*
 * Copyright 2016 Erwin Müller 
 *
 * This file is part of simplerest-owncloud-ocs.
 *
 * simplerest-owncloud-ocs is free software: you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as published by the
 * Free Software Foundation, either version 3 of the License, or (at your
 * option) any later version.
 *
 * simplerest-owncloud-ocs is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
 * details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with simplerest-owncloud-ocs. If not, see .
 */
package com.anrisoftware.simplerest.ocs;

/**
 * Share result.
 *
 * @author Erwin Müller, [email protected]
 * @since 0.1
 */
public interface ShareResult extends OwncloudData {

    /**
     * Returns the share identifier.
     *
     * @return the {@link Integer} identifier.
     */
    int getId();

    /**
     * Returns the shared link if the share was a public link.
     *
     * @return the {@link String} URL of the link or {@code null}.
     */
    String getUrl();

    /**
     * Returns the share token if the share was a public link.
     *
     * @return the {@link String} token or {@code null}.
     */
    String getToken();
}