File indexing completed on 2024-04-28 16:01:31

 /******************************************************************************
  * This file is part of the libqgit2 library
  *
  * This library 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 2.1 of the License, or (at your option) any later version.
  *
  * This library 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
  * Lesser General Public License for more details.
  *
  * You should have received a copy of the GNU Lesser General Public
  * License along with this library; if not, write to the Free Software
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
  */
 
 #ifndef LIBQGIT2_CREDENTIALS_H
 #define LIBQGIT2_CREDENTIALS_H
 
 #include <QtCore/QSharedPointer>
 
 #include "libqgit2_export.h"
 
 namespace LibQGit2
 {
 
 class CredentialsPrivate;
 
 /**
  * @brief Credentials are used to authenticate communication
  *
  * There can be different types of credentials. What types of credentials are needed depends
  * on the communication method. Credentials can be for example a user name/password combination
  * or a public key/private key pair for SSH. The user must choose a correct type of \c Credentials
  * or otherwise the authentication can fail.
  *
  * @ingroup LibQGit2
  * @{
  */
 class LIBQGIT2_EXPORT Credentials
 {
 public:
     /**
      * An empty Credentials. This does not authenticate any communication.
      */
     Credentials();
 
     bool isEmpty() const;
 
     /**
      * @brief Creates \c Credentials suitable for public key SSH authentication.
      *
      * @param privateKeyPath path to the private key file
      * @param publicKeyPath path to the public key file
      * @param userName the user name to use in the authentication
      * @param passphrase the passphrase for the private key
      * @return a new Credentials object
      */
     static Credentials ssh(const QString &privateKeyPath, const QString &publicKeyPath = QString(), const QByteArray &userName = QByteArray(), const QByteArray &passphrase = QByteArray());
 
 private:
     QSharedPointer<CredentialsPrivate> d_ptr;
     Q_DECLARE_PRIVATE(Credentials)
 
     Credentials(CredentialsPrivate &p);
 };
 
 /** @} */
 
 }
 
 #endif // LIBQGIT2_CREDENTIALS_H